docs: fix typos and rewrap markdown text to 100 columns when possible.
#276
Conversation
docs/opentitan/keymgr-dpe.md
Outdated
| HW. | ||
|
|
||
| * `-c` specify a QEMU [configuration file](otcfg.md) from which to read all the cryptographic | ||
| constants. See [`cfggen.py`](cfggen.md) tool to generate such a file. |
There was a problem hiding this comment.
| constants. See [`cfggen.py`](cfggen.md) tool to generate such a file. | |
| constants. See the [`cfggen.py`](cfggen.md) tool to generate such a file. |
docs/opentitan/spidevflash.md
Outdated
| ### Arguments | ||
|
|
||
| * `-a` specify an alernative start address' | ||
| * `-a` specify an alernaltive start address' |
There was a problem hiding this comment.
A typo in a typo :)
| * `-a` specify an alernaltive start address' | |
| * `-a` specify an alternative start address' |
docs/opentitan/spidevflash.md
Outdated
| In the following example, `-chardev socket,id=spidev,host=localhost,port=8004,server=on,wait=off | ||
| -global ot-spi_device.chardev=spidev` should be added to the QEMU command line to create a TCP |
There was a problem hiding this comment.
Maybe this command could be formatted in its own block split across lines to improve readability?
docs/opentitan/uartmux.md
Outdated
| error stream. | ||
| * `-i` / `--iface` select an alternative interface for listening on, default to localhost | ||
| * `-p` / `--port` select an altenative TCP port for listening on, default to 9000 | ||
| * `-p` / `--port` select an altenaltive TCP port for listening on, default to 9000 |
There was a problem hiding this comment.
Alternative again 😅
| * `-p` / `--port` select an altenaltive TCP port for listening on, default to 9000 | |
| * `-p` / `--port` select an alternative TCP port for listening on, default to 9000 |
rivos-eblot
force-pushed
the
dev/ebl/md_rewrap_typos
branch
from
c6ef4f4 to
9dcdc75
Compare
|
I try to follow the OT guideline which is that every new sentence (in Markdown) should start on a new line (I unfortunately messed up the first on the usbdev PR but this is fixed in the second one). This PR goes against this principle which I think is not ideal because it makes the diff/blame less useful. |
QEMU does not use Markdown but RestructuredText - which is similar. I have not found rules defining the format/syntax of |
I can revert the change fot the USBDEV file if you think it is better. For the pre-existing files, I think this rule makes the files harder to read in plain text. |
Yes, can you revert the USBDEV ? This will at least avoid the merge conflict with the other PR |
Done. |
rivos-eblot
force-pushed
the
dev/ebl/md_rewrap_typos
branch
from
9dcdc75 to
b603eb0
Compare
…n when possible. Signed-off-by: Emmanuel Blot <[email protected]>
rivos-eblot
force-pushed
the
dev/ebl/md_rewrap_typos
branch
from
b603eb0 to
a569416
Compare
3 participants
No description provided.