fix(tools): update snagboot documentation - #776
Conversation
github-actions
Bot
assigned
devarsht,
gehariprasath,
praneethbajjuri,
r-vignesh and
uditkumarti
|
New warnings found with rstcheck: |
4fcf4ef to
f7ed529
Compare
update snagboot documentaion with latest additions to the installer and github repo for yaml-configs update accpet.txt with snagboot vocabulary. Signed-off-by: Mahammed Sadik Shaik <s-sadik@ti.com>
| [Ss]nagfactory | ||
| [Ss]nagrecover | ||
| [Ss]nagflash |
There was a problem hiding this comment.
The other entries are fine as they are project names. These ones though are command names which I'm a little more hesitant to treat as proper words, especially since most command names are compound words that omit punctuation or use unusual spelling for ease of use.
If you use inline code or the command role in the documentation, vale will properly ignore it's use. Additionally, it will make it clear to the reader when you are talking about a command or something else.
I don't really know how much to enforce this here though since the upstream Snagboot docs are so lax about their spelling.
| Before using a YAML file, replace the two path placeholders with actual paths | ||
| to your binaries: | ||
|
|
||
| * ``<path_to_snagboot_binaries>/`` — recovery boot loader images built with |
| the specified configuration. | ||
|
|
||
| The following table outline the board names for snagfactory yaml configuration. | ||
| The following table outlines the board names for snagfactory YAML configuration. |
There was a problem hiding this comment.
For future reference: The yaml examples listed below can be tagged with yaml for language aware linting and syntax highlighting: https://pygments.org/docs/lexers/
|
|
||
| The script installs Snagboot by using pip, sets up udev rules so USB access works | ||
| without root, and verifies the installation. If pip installs the tools to | ||
| ``~/.local/bin`` but that directory is not on ``PATH``, add the following to ``~/.bashrc``: |
There was a problem hiding this comment.
| ``~/.local/bin`` but that directory is not on ``PATH``, add the following to ``~/.bashrc``: | |
| :file:`~/.local/bin` but that directory is not on ``PATH``, add the following to :file:`~/.bashrc`: |
Pip has a built in warning about this. Not sure how old it is. If it's present for our supported Ubuntu host version then this should be safe to omit I think. Well, unless that setup script eats the message.
| PVRTune | ||
| Sitara | ||
| Slint | ||
| SPL |
There was a problem hiding this comment.
Acronyms should not be considered valid words
7 participants
update snagboot documentaion with latest additions
to the installer and github repo for yaml-configs