Documentation Updates

Robert Schwebel r.schwebel at pengutronix.de
Fri Oct 22 12:44:52 EDT 2010


This series:

- switches doxygen to quiet output, in order to actually see the
  warnings

- fixes most of the warnings I could address; some are left and have to
  be discussed with the involved developers

- introduces a new set of macros to unify the online and offline
  documentation

- starts switching commands to this new mechanics.

The following changes since commit 298252bdef6a97d988f83f5ea554a2262c529ae2:

  process_escape_sequence: Add missing include (2010-10-21 22:21:42 +0200)

are available in the git repository at:
  http://git.pengutronix.de/git/rsc/barebox for-mainline

Robert Schwebel (32):
      reset_cpu: unify declaration
      Doxyfile: enable quiet output
      Doxyfile: remove obsolete boards directory
      Doxyfile: add exclude rules
      Doxyfile: remove non-existing directories
      Doxyfile: remove unused features
      Doxyfile: enable assembler files
      doc: let doxygen find some assembler functions
      doc: remove nonexisting command
      doc: remove reference to non-existing documentation
      doc: eliminate nonexisting reference
      doc: add missing quoting
      doc: fix typo
      doc: mark code explicitely
      doc: avoid that doxygen parses magic in command.h
      doc: fix wrongly named parameter
      doc: fix parameter name in mci-core
      doc: silence doxygen warnings
      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'

 Documentation/commands.dox            |    8 ++-
 Documentation/developers_manual.dox   |    1 -
 Documentation/users_manual.dox        |    1 -
 Doxyfile                              |   22 ++++---
 arch/arm/mach-at91/at91sam926x_time.c |    2 +-
 arch/arm/mach-ep93xx/clocksource.c    |    2 +-
 arch/arm/mach-imx/clocksource.c       |    2 +-
 arch/arm/mach-omap/arch-omap.dox      |    6 ++-
 arch/arm/mach-omap/omap3_generic.c    |    4 +-
 arch/arm/mach-s3c24xx/lowlevel-init.S |    2 +-
 arch/arm/mach-stm/reset-imx23.c       |    2 +-
 arch/blackfin/lib/cpu.c               |    2 +-
 arch/m68k/mach-mcfv4e/mcf_reset_cpu.c |    2 +-
 arch/ppc/mach-mpc5xxx/cpu.c           |    2 +-
 arch/sandbox/os/common.c              |    2 +-
 arch/x86/boot/boot_hdisk.S            |    2 -
 arch/x86/boot/boot_main.S             |    2 -
 arch/x86/boot/pmjump.S                |    2 -
 arch/x86/lib/memory16.S               |    2 -
 arch/x86/lib/traveler.S               |    3 -
 arch/x86/mach-x86.dox                 |    2 +-
 commands/bmp.c                        |   16 +++---
 commands/bootm.c                      |   18 ++----
 commands/cat.c                        |   19 ++----
 commands/cd.c                         |   17 ++----
 commands/clear.c                      |    5 ++
 commands/cp.c                         |   24 +++-----
 commands/crc.c                        |   15 ++---
 commands/dfu.c                        |   21 ++++---
 commands/echo.c                       |   10 +++
 commands/edit.c                       |   36 ++++--------
 commands/ls.c                         |    9 ++-
 commands/partition.c                  |   58 +++++--------------
 common/kallsyms.c                     |    4 +
 drivers/mci/mci-core.c                |    2 +-
 include/command.h                     |   13 ++++
 lib/parameter.c                       |    2 +-
 scripts/doxy_filter.awk               |  101 +++++++++++++++++++++++++++++++++
 38 files changed, 254 insertions(+), 189 deletions(-)
 create mode 100644 scripts/doxy_filter.awk




More information about the barebox mailing list