search

zephyrproject-rtos / zephyr

Primary Git Repository for the Zephyr Project. Zephyr is a new generation, scalable, optimized, secure RTOS for multiple hardware architectures.
https://docs.zephyrproject.org
Apache License 2.0
10.93k stars 6.65k forks source link

doc: Documentation issue in 'samples/subsys/usb/dfu/README' #65484

Open woodm528 opened 1 year ago

woodm528 commented 1 year ago

Documentation issue

Document call out the use of dfu-util but provides no reference on context in which the command can be issued. For instance

dfu-util --alt 0 --upload slot0_backup.bin

Searching the docs for dfu-util provides nothing

I am running a Nordic nrf52840 build environment from vscode. I tried the command in the vscode terminal powershell. which seemed to be the most likely context, It's not recognized there

Where or how is this command executed?

Environment

github-actions[bot] commented 1 year ago

Hi @woodm528! We appreciate you submitting your first issue for our open-source project. 🌟

Even though I'm a bot, I can assure you that the whole community is genuinely grateful for your time and effort. 🤖💙

kartben commented 1 year ago

@jfischer-no

CarlMitchellKT commented 11 months ago

It's a Linux utility, and is not installed by default on most distributions (but there are dozens of distros, so yours may have it already). So from the Linux machine you've connected to your device.

The context is in the doc at the start of the "Testing" section: "The Linux dfu-util tool can be used to backup or update the application image.". Knowledge of how to use Linux systems is necessarily assumed by the Zephyr docs, and (IMO) is out of scope in Zephyr's docs.

jfischer-no commented 10 months ago

Valid complaint and sample documentation can be improved.