doc: bootloader_partitioning: add info about VSC #18045
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
doc-required
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:more detailsGithub labels
List of changed files detected by CI (0)Outputs:ToolchainVersion: Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
greg-fer
removed
the
changelog-entry-required
|
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. |
hellesvik-nordic
approved these changes
Oct 21, 2024
| .. group-tab:: nRF Connect for VS Code | ||
|
|
||
| Use the extension's `Memory report`_ feature, which shows the size and percentage of memory that each symbol uses on your device for RAM, ROM, and partitions. | ||
| Click the :guilabel:`Memory report` button in the :guilabel:`Actions View` to generate the report. |
There was a problem hiding this comment.
If we want to be even more specific, we can instruct users to then choose the "partitioning" tab.
| Use the Partition Manager's :ref:`pm_partition_reports` feature. | ||
| Run the following command: | ||
|
|
||
| .. code-block: console |
There was a problem hiding this comment.
Cant see command.
annwoj
reviewed
Oct 21, 2024
| ****************** | ||
|
|
||
| After you enable the Partition Manager, it will :ref:`start generating <pm_build_system>` the :file:`partitions.yml` file in the build folder directory. | ||
| In this file, you will detailed information about the memory layout used for the build. |
There was a problem hiding this comment.
Suggested change
| In this file, you will detailed information about the memory layout used for the build. | |
| In this file, you will see detailed information about the memory layout used for the build. |
| Click the :guilabel:`Memory report` button in the :guilabel:`Actions View` to generate the report. | ||
|
|
||
| Alternatively, you can also use the `Memory Explorer <How to work with the Memory Explorer_>`_ feature of the extension's nRF Debug to check memory sections for the partitions. | ||
| This feature requires `enabling debugging in the build configuration <How to debug>`_ and providing the partition addresses manually. |
There was a problem hiding this comment.
The link's not working
Suggested change
| This feature requires `enabling debugging in the build configuration <How to debug>`_ and providing the partition addresses manually. | |
| This feature requires `enabling debugging in the build configuration <How to debug_>`_ and providing the partition addresses manually. |
Edited the structure of bootloader_partitioning page to mention memory reports of the VSC extension alongside partition_manager_report. Fixed some formatting and structure issues and typos. VSC-2712. Signed-off-by: Grzegorz Ferenc <[email protected]>
greg-fer
force-pushed
the
doc_mention_vsc_memory_report_for_flash_partitions
branch
from
c3a9d9e
to
aa33cad
Compare
github-actions
bot
added
the
changelog-entry-required
annwoj
approved these changes
Oct 22, 2024
FilipZajdel
approved these changes
Oct 22, 2024
greg-fer
changed the title
|
@FilipZajdel and @hellesvik-nordic discovered inconsistencies in the extension behavior that will be fixed for the next release. This PR will be merged once those fixes are live. |
|
Fixes merged by @AliceMadama . Awaiting the release of the extension to ask for merge for this PR. |
greg-fer
added
backport v2.8-branch
greg-fer
changed the title
rlubos
approved these changes
Nov 6, 2024
|
@nrfconnect/ncs-aurora-doc Ping, please review |
FrancescoSer
approved these changes
Nov 6, 2024
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.
Edited the structure of bootloader_partitioning page to mention memory reports of the VSC extension alongside partition_manager_report. Fixed some formatting and structure issues and typos. VSC-2712.