doc: Remove use of SoC when referencing SiPs #12211
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
doc-required
Test specificationCI/Jenkins/NRF
CI/Jenkins/integration
Note: This message is automatically posted and updated by the CI |
greg-fer
requested changes
Sep 1, 2023
doc/nrf/security/ap_protect.rst
Outdated
| :header-rows: 1 | ||
| :align: center | ||
| :widths: auto | ||
|
|
||
| * - SoC | ||
| * - Device |
There was a problem hiding this comment.
We're specifically referring to SoCs here, because of the link to hardware documentation (we don't have sections about AP-Protect for each device, just for SoC) and because otherwise we would need to list all devices, such as Thingy:91 and so on.
Suggested change
| * - Device | |
| * - SoC or SiP |
doc/nrf/security/ap_protect.rst
Outdated
| @@ -9,7 +9,7 @@ Enabling access port protection mechanism | |||
|
|
|||
| .. app_approtect_info_start | |||
|
|
|||
| Several Nordic Semiconductor SoCs supported in the |NCS| offer an implementation of the access port protection mechanism (AP-Protect). | |||
| Several Nordic Semiconductor devices supported in the |NCS| offer an implementation of the access port protection mechanism (AP-Protect). | |||
There was a problem hiding this comment.
Suggested change
| Several Nordic Semiconductor devices supported in the |NCS| offer an implementation of the access port protection mechanism (AP-Protect). | |
| Several Nordic Semiconductor SoCs and SiPs supported in the |NCS| offer an implementation of the access port protection mechanism (AP-Protect). |
And like this in other cases, see my first comment.
| @@ -914,3 +914,4 @@ Documentation | |||
| * :ref:`release_notes`, :ref:`software_maturity`, :ref:`known_issues`, :ref:`glossary`, and :ref:`dev-model` are now located under :ref:`releases_and_maturity`. | |||
|
|
|||
| * The :ref:`ug_thread` documentation to improve the overall presentation and add additional details where necessary. | |||
| * The :ref:`app_approtect` page to use the device term instead of SoC when also SiPs are referenced or mentioned. | |||
There was a problem hiding this comment.
This is a very minor edit. I don't think it is relevant for the customers to know about it from the release notes.
|
You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds. Note: This comment is automatically posted by the Documentation Publishing GitHub Action. |
mia-ko
force-pushed
the
replace-soc-with-another-term-in-approtect-guide
branch
from
7feeeca
to
1fb914f
Compare
github-actions
bot
added
the
changelog-entry-required
divipillai
approved these changes
Sep 1, 2023
greg-fer
approved these changes
Sep 21, 2023
mia-ko
force-pushed
the
replace-soc-with-another-term-in-approtect-guide
branch
from
1fb914f
to
82c37d1
Compare
AP-Prot guide uses SoC in text and tables even when nRF9160 is listed or mentioned. Use the term device instead for those cases (NCSDK-21451). Signed-off-by: Mia Koen <[email protected]>
mia-ko
force-pushed
the
replace-soc-with-another-term-in-approtect-guide
branch
from
82c37d1
to
05bf6dc
Compare
mia-ko
removed
the
changelog-entry-required
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
AP-Prot guide uses SoC in text and tables even when nRF9160 is listed or mentioned. Use the term device instead for those cases (NCSDK-21451).