doc improvement: sysbuild + HWMv2 + misc edits #15830
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
greg-fer
force-pushed
the
doc_sysbuild_hwm2_doc_updates
branch
from
9b4da2a
to
0c483de
Compare
greg-fer
changed the title
greg-fer
force-pushed
the
doc_sysbuild_hwm2_doc_updates
branch
from
0c483de
to
1708630
Compare
greg-fer
requested review from
zycz,
e-rk,
KAGA164,
maje-emb,
alstrzebonski,
MarekPieta,
alwa-nordic,
jori-nordic,
carlescufi,
FrancescoSer and
dchat-nordic
as code owners
greg-fer
force-pushed
the
doc_sysbuild_hwm2_doc_updates
branch
2 times, most recently
from
4269f5b
to
ac4f70f
Compare
|
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. |
ahasztag
approved these changes
Jun 11, 2024
zycz
approved these changes
Jun 11, 2024
ludvigsj
approved these changes
Jun 11, 2024
greg-fer
commented
Jun 11, 2024
| See also :ref:`programming` for programming steps and :ref:`testing` for general information about testing and debugging in the |NCS|. | ||
|
|
||
| .. note:: | ||
| In the |NCS|, building with Sysbuild is :ref:`enabled by default <sysbuild_enabled_ncs>`. |
There was a problem hiding this comment.
Note to self: fix capitalization in .txt.
greg-fer
force-pushed
the
doc_sysbuild_hwm2_doc_updates
branch
from
f34eb7f
to
de09e47
Compare
greg-fer
changed the title
|
@greg-fer is this NCS 2.7.0 ? Milestone |
|
@shanthanordic , it is! Thanks for spotting. Added. |
greg-fer
added a commit
to greg-fer/fw-nrfconnect-nrf-1
that referenced
this pull request
Jun 11, 2024
Added changelog entries for recent edits to Working with guides. Re PRs nrfconnect#15598, nrfconnect#15139, nrfconnect#15661, nrfconnect#15708, nrfconnect#15596. Added changelog entry for edits about sysbuild. Re PR nrfconnect#15830. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 task
greg-fer
added a commit
to greg-fer/fw-nrfconnect-nrf-1
that referenced
this pull request
Jun 12, 2024
Added changelog entries for recent edits to Working with guides. Re PRs nrfconnect#15598, nrfconnect#15139, nrfconnect#15661, nrfconnect#15708, nrfconnect#15596. Added changelog entry for edits about sysbuild. Re PR nrfconnect#15830. Signed-off-by: Grzegorz Ferenc <[email protected]>
nordicjm
reviewed
Jun 12, 2024
|
|
||
| To enable the firmware, use the Sysbuild configuration of :kconfig:option:`SB_CONFIG_NRF_DEFAULT_IPC_RADIO`. | ||
| To enable the firmware, use the sysbuild configuration of :kconfig:option:`SB_CONFIG_NRF_DEFAULT_IPC_RADIO`. |
There was a problem hiding this comment.
this is for nordic sample applications only, customer applications should use SB_CONFIG_NETCORE_IPC_RADIO
There was a problem hiding this comment.
Created a task for @dchat-nordic : https://nordicsemi.atlassian.net/browse/NCSDK-27939
Comment on lines
266
to
267
| In the |NCS|, building an application using the :ref:`standard building procedure <building>` automatically includes :ref:`configuration_system_overview_sysbuild` (the ``--sysbuild`` parameter). | ||
| For this reason, unlike in Zephyr, ``--sysbuild`` does not have to be explicitly mentioned in the command prompt. |
There was a problem hiding this comment.
This should make it clear it is NCS repos, not NCS in general, if a customer builds their own manifest then it will not enable sysbuild by default in their custom included repos but will in the ncs repos inside of that manifest
| In the |NCS|, this command builds the application with :ref:`sysbuild enabled by default <sysbuild_enabled_ncs>`. | ||
| It can be expanded with :ref:`optional_build_parameters`, such as :ref:`custom CMake options <cmake_options>` or the ``--no-sysbuild`` parameter that disables building with sysbuild. | ||
|
|
||
| After running the ``west build`` command, the build files can be found in :file:`build/zephyr` by default. |
There was a problem hiding this comment.
|
|
||
| west build -b <board_name> -- -DFILE_SUFFIX=release | ||
| west build -b *board_target* -- -DFILE_SUFFIX=release |
There was a problem hiding this comment.
non blocking but the < and > make it obvious to a user that they need to change something more than * (which I assume just makes it bold?)
There was a problem hiding this comment.
It makes it italic, hence more noticeable in the doc rendering. This is the formatting we've been using for all custom parameters.
greg-fer
added a commit
to greg-fer/fw-nrfconnect-nrf-1
that referenced
this pull request
Jun 12, 2024
Added changelog entries for recent edits to Working with guides. Re PRs nrfconnect#15598, nrfconnect#15139, nrfconnect#15661, nrfconnect#15708, nrfconnect#15596. Added changelog entry for edits about sysbuild. Re PR nrfconnect#15830. Signed-off-by: Grzegorz Ferenc <[email protected]>
greg-fer
force-pushed
the
doc_sysbuild_hwm2_doc_updates
branch
3 times, most recently
from
20581c6
to
d0f949d
Compare
umapraseeda
approved these changes
Jun 12, 2024
|
@greg-fer please resolve the conflicts. |
greg-fer
force-pushed
the
doc_sysbuild_hwm2_doc_updates
branch
from
d0f949d
to
22df92f
Compare
Added a note about transition to HWMv2 under Board names. Aligned mentions of sysbuild. Added sysbuild-specific mentions to programming and building info. Removed unused include files for build_and_run. Fixed documentation formatting for SUIT recovery. Fixed a couple of outdated *board_name* to *board_target*. Signed-off-by: Grzegorz Ferenc <[email protected]>
greg-fer
force-pushed
the
doc_sysbuild_hwm2_doc_updates
branch
from
22df92f
to
874e9b6
Compare
kittydepa
approved these changes
Jun 13, 2024
nordicjm
approved these changes
Jun 13, 2024
greg-fer
added a commit
to greg-fer/fw-nrfconnect-nrf-1
that referenced
this pull request
Jun 13, 2024
Added changelog entries for recent edits to Working with guides. Re PRs nrfconnect#15598, nrfconnect#15139, nrfconnect#15661, nrfconnect#15708, nrfconnect#15596. Added changelog entry for edits about sysbuild. Re PR nrfconnect#15830. Signed-off-by: Grzegorz Ferenc <[email protected]>
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.
Added a note about transition to HWMv2 under Board names.
Aligned mentions of sysbuild.
Added sysbuild-specific mentions to programming and building info.
Removed unused include files for build_and_run.
Fixed documentation formatting for SUIT recovery.
Fixed a couple of outdated board_name to board_target.