docs: trivial fixes#533
Conversation
|
These files are generated. Has the same change been made upstream? |
Unless I'm mistaken this is the upstream and seL4 docs sources off the microkit manual? |
| 2. Set the `a0` and `a1` registers for OpenSBI | ||
|
|
||
| # tell OpenSBI where DTB is (there is none) | ||
| (gdb) # tell OpenSBI where DTB is (there is none) |
There was a problem hiding this comment.
I'd rather these be placed in backticks ``` and indentation removed, I think.
IDK why the markdown parswr would be parsing headings when its indented for a coxe block...
There was a problem hiding this comment.
It seems that the manual PDF and GitHub both parse this correctly?
I don't understand this change.
There was a problem hiding this comment.
Standard markdown specs would definitely not parse this as heading. Indented code blocks are not an exotic feature, but putting it into a fenced code block like @midnightveil suggests would fix any ambiguity if you want to be extra sure.
Adding (gdb) seems not good to me, because (gdb) is the prompt and the line is supposed to be a comment between prompts.
There was a problem hiding this comment.
It turned out that I was misled by the outline plugin in my text editor:
Anyway, I can ignore it now as it looks like a bug of that plugin.
I've updated the commit to keep original form as it is following markdown rule.
Wow, yes, I don't know how I hallucinated the docs repo here. Apologies. This is absolutely the right repo for this change. |
Some trivial fixes in manual.md like: - Add missing break in 10.2 so that list is correctly rendered in PDF version. Signed-off-by: Yanfeng Liu <yfliu2008@qq.com>
3 participants
Some trivial fixes in manual.md like:
(gdb)before GDB comments so that markdown tools don't take them as new title lines.