From: Robert Schwebel <r.schwebel@pengutronix.de>
To: barebox@lists.infradead.org
Subject: Unified Documentation
Date: Mon, 1 Nov 2010 09:33:33 +0100 [thread overview]
Message-ID: <1288600434-6112-1-git-send-email-r.schwebel@pengutronix.de> (raw)
This series contains the next round of documentation rework, in order to
avoid the duplication of several documentation sniplets between the
compiled-in documentation (help <command>) and the online documentation
managed by Doxygen.
Since these patches have been posted last time, I've reworked the awk
script that generates the Doxygen input slightly. It is now possible to
add long prosa text blocks which do only appear in the online manual.
The following changes since commit bd8db893bb65e32952f8389d37f868e2c6f82d21:
doc: silence doxygen warnings (2010-10-22 20:47:03 +0200)
are available in the git repository at:
http://git.pengutronix.de/git/rsc/barebox ..BRANCH.NOT.VERIFIED..
Robert Schwebel (21):
doc: fix typo
doc: add macros to unify command help with doxygen
doc: add documentation for 'bmp'
doc: add documentation for 'clear'
doc: add documentation for 'crc32'
doc: add documentation for 'dfu'
doc: unify documentation for 'ls'
doc: unify documentation for 'cat'
doc: unify documentation for 'cd'
doc: add documentation for 'echo'
doc: unify documentation for 'edit'
doc: add documentation for 'bootm'
doc: unify documentation for 'addpart'
doc: unify documentation for 'cp'
doc: unify documentation for 'delpart'
doc: rework user manual
doc: unify documentation for 'devinfo'
doc: unify documentation for 'erase'
doc: rework and unify documentation for gpio commands
doc: unify documentation for 'export'
doc: unify documentation for 'tftp'
Documentation/barebox-main.dox | 232 ++++++++++-----------------------
Documentation/building.dox | 62 +++++++++
Documentation/commands.dox | 29 ++++-
Documentation/first_steps.dox | 61 +++++++++
Documentation/users_manual.dox | 13 +-
Doxyfile | 7 +-
arch/arm/mach-s3c24xx/lowlevel-init.S | 2 +-
commands/bmp.c | 27 +++-
commands/bootm.c | 38 +++---
commands/cat.c | 19 +--
commands/cd.c | 17 +--
commands/clear.c | 5 +
commands/cp.c | 30 ++---
commands/crc.c | 15 +-
commands/dfu.c | 28 +++--
commands/echo.c | 17 +++
commands/edit.c | 38 ++----
commands/export.c | 14 +--
commands/flash.c | 30 +++--
commands/gpio.c | 100 ++++++++-------
commands/ls.c | 9 +-
commands/partition.c | 75 +++++------
include/command.h | 9 ++
lib/driver.c | 45 ++++---
net/tftp.c | 49 +++----
scripts/doxy_filter.awk | 103 +++++++++++++++
26 files changed, 627 insertions(+), 447 deletions(-)
create mode 100644 Documentation/building.dox
create mode 100644 Documentation/first_steps.dox
create mode 100644 scripts/doxy_filter.awk
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
next reply other threads:[~2010-11-01 8:34 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-11-01 8:33 Robert Schwebel [this message]
2010-11-01 8:33 ` [PATCH 01/21] doc: fix typo Robert Schwebel
2010-11-01 8:33 ` [PATCH 02/21] doc: add macros to unify command help with doxygen Robert Schwebel
2010-11-01 8:33 ` [PATCH 03/21] doc: add documentation for 'bmp' Robert Schwebel
2010-11-01 8:33 ` [PATCH 04/21] doc: add documentation for 'clear' Robert Schwebel
2010-11-01 8:33 ` [PATCH 05/21] doc: add documentation for 'crc32' Robert Schwebel
2010-11-01 8:33 ` [PATCH 06/21] doc: add documentation for 'dfu' Robert Schwebel
2010-11-01 8:51 ` Baruch Siach
2010-11-01 10:03 ` Robert Schwebel
2010-11-01 8:33 ` [PATCH 07/21] doc: unify documentation for 'ls' Robert Schwebel
2010-11-01 8:33 ` [PATCH 08/21] doc: unify documentation for 'cat' Robert Schwebel
2010-11-01 8:33 ` [PATCH 09/21] doc: unify documentation for 'cd' Robert Schwebel
2010-11-01 8:33 ` [PATCH 10/21] doc: add documentation for 'echo' Robert Schwebel
2010-11-01 8:33 ` [PATCH 11/21] doc: unify documentation for 'edit' Robert Schwebel
2010-11-01 8:33 ` [PATCH 12/21] doc: add documentation for 'bootm' Robert Schwebel
2010-11-01 8:33 ` [PATCH 13/21] doc: unify documentation for 'addpart' Robert Schwebel
2010-11-01 8:33 ` [PATCH 14/21] doc: unify documentation for 'cp' Robert Schwebel
2010-11-01 8:33 ` [PATCH 15/21] doc: unify documentation for 'delpart' Robert Schwebel
2010-11-01 8:33 ` [PATCH 16/21] doc: rework user manual Robert Schwebel
2010-11-01 8:33 ` [PATCH 17/21] doc: unify documentation for 'devinfo' Robert Schwebel
2010-11-01 8:33 ` [PATCH 18/21] doc: unify documentation for 'erase' Robert Schwebel
2010-11-01 8:33 ` [PATCH 19/21] doc: rework and unify documentation for gpio commands Robert Schwebel
2010-11-01 8:33 ` [PATCH 20/21] doc: unify documentation for 'export' Robert Schwebel
2010-11-01 8:33 ` [PATCH 21/21] doc: unify documentation for 'tftp' Robert Schwebel
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1288600434-6112-1-git-send-email-r.schwebel@pengutronix.de \
--to=r.schwebel@pengutronix.de \
--cc=barebox@lists.infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox