[riot-notifications] [RIOT-OS/RIOT] feather-nrf52840: several fixes to documentation (#16777)

Martine Lenders notifications at github.com
Tue Aug 24 18:13:37 CEST 2021

The RIOT community cares a lot about code quality.
Therefore, before describing what your contribution is about, we would like
you to make sure that your modifications are compliant with the RIOT
coding conventions, see https://github.com/RIOT-OS/RIOT/wiki/Coding-conventions.

### Contribution description
This fixes several issues with the documentation of the `feather-nrf52840` documentation:

- malformed formatting of the shell commands
- typo in requirements and missing info where to find them
- missing commands in shell commands to let them run out of the box
- out-dated doc on terminal

Put here the description of your contribution:
- describe which part(s) of RIOT is (are) involved
- if it's a bug fix, describe the bug that it solves and how it is solved
- you can also give more information to reviewers about how to test your changes

### Testing procedure
Compile documentation with `make doc`. The output should now look much nicer and contain much more information compared to the current doc.riot-os.org. Also try out the instructions. The `feather-nrf52840` should mount as a disk drive afterwards (for Arch and Fedora I needed to patch `dist/tools/uf2/uf2conv.py` to be able to flash:

--- build/pkg/UF2/utils/uf2conv.py	2021-08-24 16:37:10.613961049 +0200
+++ dist/tools/uf2/uf2conv.py	2021-08-24 17:57:43.061182395 +0200
@@ -200,9 +200,13 @@
         if sys.platform == "darwin":
             rootpath = "/Volumes"
         elif sys.platform == "linux":
-            tmp = rootpath + "/" + os.environ["USER"]
+            tmp = os.path.join(rootpath, os.environ["USER"])
             if os.path.isdir(tmp):
                 rootpath = tmp
+            else:
+                tmp = os.path.join("/run/media", os.environ["USER"])
+                if os.path.isdir(tmp):
+                    rootpath = tmp
         for d in os.listdir(rootpath):
             drives.append(os.path.join(rootpath, d))

((question is: does it make sense to push this patch upstream... the tool does not look like it was written by someone with a whole lot of knowledge about Linux...)
Details steps to test your contribution:
- which test/example to compile for which board and is there a 'test' command
- how to know that it was not working/available in master
- the expected success test output

### Issues/PRs references
Follow-up on https://github.com/RIOT-OS/RIOT/pull/16276
Examples: Fixes #1234. See also #5678. Depends on PR #9876.

Please use keywords (e.g., fixes, resolve) with the links to the issues you
resolved, this way they will be automatically closed when your pull request
is merged. See https://help.github.com/articles/closing-issues-using-keywords/.

You can view, comment on, or merge this pull request online at:


-- Commit Summary --

  * boards/feather-nrf52840: fix typo and link where to get `nrfjprog` tool
  * boards/feather-nrf52840: fix shell command formatting in doc
  * boards/feather-nrf52840: add missing commands for uf2 instructions
  * boards/feather-nrf52840: update terminal doc for current status quo

-- File Changes --

    M boards/feather-nrf52840/doc.txt (31)

-- Patch Links --


You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20210824/8d86ce07/attachment.htm>

More information about the notifications mailing list