Unified Documentation

Robert Schwebel r.schwebel at pengutronix.de
Mon Nov 1 04:33:33 EDT 2010


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




More information about the barebox mailing list