| Age | Commit message (Collapse) | Author | Files | Lines |
|---|
|
MarkDown is really nice and easy to get something quickly but
for manpages, the rendering is not really nice and lack index entries.
reST has a special syntax for option lists but:
1) not all option syntax are recognized (for example when we use [xyz] to
to show that xyz is optionnal).
2) when converted to HTML, a table is used for the list but:
* options that are too long break the presentation
* unrecognized options break the table
3) the options are also not put in the index
Solve this by using reST with '.. option::' directives.
Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
|
|
The file dev-options.md contains the description for extra
options not useful for sparse itself and its users but well
to sparse's developers and for tools like test-linearize.
Since it's a complement to the main man-page, format it at such.
Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
|
|
With this we can generate HTML for the docs in this directory.
For the moment, more as an experiment as anything else, this
doc is available at http://sparse-doc.rtfd.io
Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
|
