[Lldb-commits] [PATCH] D55376: Generate LLDB website/documentation from rst with Sphinx

[Stefan Gränitz via Phabricator via lldb-commits]

sgraenitz added a comment.

I think this is going to be really nice! Here's a few details I found.



================
Comment at: docs/use/map.rst:28
++------------------------------------------------------------------------------+-------------------------------------------------------+
+| Launch a process with arguments <args>.                                                                                              |
++------------------------------------------------------------------------------+-------------------------------------------------------+
----------------
Maybe all `<` and `>` should be changed to `<` and `>` respectively?
`<args>` here somehow survives, but all other other angle-brackets content disappears.


================
Comment at: docs/use/map.rst:30
++------------------------------------------------------------------------------+-------------------------------------------------------+
+| **(gdb)** run                                                                | **(lldb)** process launch --                          |
+|                                                                              |                                                       |
----------------
Unfortunately all `--` turn into one large `–`. Is it possible to disable (or escape each instance)?


================
Comment at: docs/use/map.rst:236
+|                                                                |                                                                                 |
+| *(Hope that there are no C functions named **main**)*.         | **(lldb)** br s -M main                                                         |
++----------------------------------------------------------------+---------------------------------------------------------------------------------+
----------------
Interestingly this turns into `(Hope that there are no C functions named **main*)*`
There is another case below. BTW do we really need these comments?


================
Comment at: docs/use/map.rst:330
+|                                                                                                                             |                                                                                                                                                                                                    |
+|                                                                                                                             |  * thread #1: tid = 0x1c03, 0x0000000100000ef5 a.out`modify + 21 at main.cpp:16, stop reason = watchpoint 1                                                                                        |
+|                                                                                                                             |                                                                                                                                                                                                    |
----------------
Could the `*` be escaped? Otherwise this turns into a bullet point.


================
Comment at: docs/use/map.rst:858
++----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| **(gdb)** echo Here is some text\n                                                                                                                             | **(lldb)** script print "Here is some text"                                                                                                                         |
++----------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
----------------
The `\` disappears.


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D55376/new/

https://reviews.llvm.org/D55376