doc: nrf util: usb driver prerequisite for win #19809
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;
|
|
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 Publish GitHub Action. |
qung
approved these changes
Jan 9, 2025
greg-fer
force-pushed
the
doc_nrfutil_jlink_usb_driver_req
branch
from
66cba88 to
2c1f71e
Compare
github-actions
bot
removed
the
changelog-entry-required
greg-fer
force-pushed
the
doc_nrfutil_jlink_usb_driver_req
branch
2 times, most recently
from
376a63f to
4cf4351
Compare
peknis
requested changes
Jan 10, 2025
| * For Windows, add it to the environment variables. | ||
|
|
||
| * SEGGER J-Link |jlink_ver| and, on Windows, also the SEGGER USB Driver for J-Link from `SEGGER J-Link`_ |jlink_ver|. | ||
| For information how to install the USB Driver, see the `nRF Util prerequisites`_ documentation. |
There was a problem hiding this comment.
Suggested change
| For information how to install the USB Driver, see the `nRF Util prerequisites`_ documentation. | |
| For information on how to install the USB Driver, see the `nRF Util prerequisites <nRF Util prerequisites_>`_ documentation. |
There was a problem hiding this comment.
I won't be updating prerequisites to prequisites.
There was a problem hiding this comment.
Sorry for the typo. It is gone now.
doc/nrf/installation/install_ncs.rst
Outdated
| * The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_. | ||
| * In |VSC|, the latest version of the `nRF Connect for VS Code Extension Pack`_. | ||
|
|
||
| * Additionally for Windows users: SEGGER USB Driver for J-Link, required for support of older Nordic Semiconductor devices in nRF Util. | ||
| For information how to install the USB Driver, see the `nRF Util prerequisites`_ documentation. |
There was a problem hiding this comment.
Suggested change
| For information how to install the USB Driver, see the `nRF Util prerequisites`_ documentation. | |
| For information on how to install the USB Driver, see the `nRF Util prerequisites <nRF Util prerequisites_>`_ documentation. |
There was a problem hiding this comment.
In the target page of the link, change "What J-link version..." to Which J-link version...
doc/nrf/installation/install_ncs.rst
Outdated
|
|
||
| * Additionally for Windows users: SEGGER USB Driver for J-Link, required for support of older Nordic Semiconductor devices in nRF Util. | ||
| For information how to install the USB Driver, see the `nRF Util prerequisites`_ documentation. |
There was a problem hiding this comment.
Suggested change
| For information how to install the USB Driver, see the `nRF Util prerequisites`_ documentation. | |
| For information on how to install the USB Driver, see the `nRF Util prerequisites <nRF Util prerequisites_>`_ documentation. |
| @@ -287,6 +287,9 @@ Among others, this package includes the J-Link RTT Viewer, which can be used for | |||
|
|
|||
| It is recommended to use the |jlink_ver| of the package when you :ref:`installing_vsc`. | |||
|
|
|||
| On Windows, you also need to install SEGGER USB Driver for J-Link, which is required for support of older Nordic Semiconductor devices in :ref:`requirements_nrf_util`. | |||
| For information how to install the USB Driver, see the `nRF Util prerequisites`_ documentation. | |||
There was a problem hiding this comment.
Suggested change
| For information how to install the USB Driver, see the `nRF Util prerequisites`_ documentation. | |
| For information on how to install the USB Driver, see the `nRF Util prerequisites <nRF Util prerequisites_>`_ documentation. |
annwoj
reviewed
Jan 10, 2025
doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
Outdated
Show resolved
Hide resolved
umapraseeda
approved these changes
Jan 10, 2025
KievDevel
approved these changes
Jan 10, 2025
Added information about the required installation of USB Driver for J-Link on Windows. Moved installation instructions to nRF Util docs and removed them from the nRF54H20 Getting Started Guide. NCD-909. Signed-off-by: Grzegorz Ferenc <[email protected]>
greg-fer
force-pushed
the
doc_nrfutil_jlink_usb_driver_req
branch
from
4cf4351 to
bcc0d22
Compare
annwoj
approved these changes
Jan 10, 2025
peknis
approved these changes
Jan 13, 2025
rlubos
approved these changes
Jan 13, 2025
|
Requested merge to @rlubos because @annwoj 's approval fulfills the requirement for nRF54H20-related doc edits, as per https://nordicsemi.atlassian.net/wiki/spaces/TECHDOC/pages/120302385/NCS+team+assignment |
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 information about the required installation of USB Driver for J-Link on Windows. Moved installation instructions to nRF Util docs and removed them from the nRF54H20 Getting Started Guide. NCD-909.
Related nRF Util PR https://github.com/NordicSemiconductor/nrfutil-rs/pull/2563