9
0
Fork 0
Commit Graph

5 Commits

Author SHA1 Message Date
Jan Luebbe a1a5a21298 Documentation: handle missing group declaration
Use group 'misc' as a default and print a warning.

Signed-off-by: Jan Luebbe <jlu@pengutronix.de>
2015-03-10 15:04:23 +01:00
Holger Schurig 2f0f5522a8 Documentation: change generated help lines
Someone

   loadx (load binary file over serial line (X-Modem))

looked more silly than

   loadx - load binary file over serial line (X-Modem)

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-07-22 21:16:06 +02:00
Holger Schurig 46e8bf7487 Documentation: only write changed *.rst files
Documentation/gen_commands.py use to re-write all auto-generated *.rst
file, changed or not. That in turn didn't work well with the internal
cache of the Sphinx documentation generator.

By comparing the SHA1 hash of the newly generated *.rst with the
current sha1 file, the time to execute "make docs" can be reduced
from 6.2s to 2.4s on my humble laptop.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-07-22 21:16:06 +02:00
Jan Luebbe c949b66674 Documentation: use command groups
The help definition already contained a group declaration.
This is now reused for the HTML documentation.

Signed-off-by: Jan Luebbe <jlu@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-07-14 10:42:31 +02:00
Sascha Hauer 3fef396bb4 Documentation: Add new sphinxs docs
This is a rewrite of the Documentation in reStructuredText format using
Sphinx as build system, see http://sphinx-doc.org/.

The documentation is built into static html pages with 'make docs'.
The pages can be found under Documentation/html after building.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-06-26 11:07:10 +02:00