documentation updates

documentation updates

[Robert Schwebel]

Here is the next round of documentation updates.

The following changes since commit f0e62e69a58e249e11fc33f993e4cdb95eac6ea3:

  cpuimx35: fix warning (2010-11-02 09:58:47 +0100)

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

Robert Schwebel (13):
      doc: remove obsolete link method for arch specification
      doc: unify documentation for 'loadenv'
      doc: remove ..., confuses doxygen
      doc: unify documentation for 'mount'
      doc: unify documentation for 'printenv'
      doc: unify documentation for 'protect' and 'unprotect'
      doc: unify documentation for 'saveenv'
      doc: unify documentation for 'setenv'
      doc: remove sh from command documentation
      doc: unify documentation for 'linux16'
      doc: put CPUIMX35 into the right chapter
      doc: put babage board into the right chapter
      doc: put cupid into the right chapter

 Documentation/boards.dox                        |    4 +
 Documentation/building.dox                      |   14 ++---
 Documentation/commands.dox                      |    1 -
 arch/arm/boards/freescale-mx51-pdk/mx51-pdk.dox |    2 +-
 arch/arm/boards/guf-cupid/cupid.dox             |    2 +-
 commands/flash.c                                |   76 +++++++++++++---------
 commands/linux16.c                              |   25 ++++----
 commands/loadenv.c                              |   34 ++++------
 commands/ls.c                                   |    2 +-
 commands/mount.c                                |   78 +++++++++++------------
 commands/printenv.c                             |   30 ++++-----
 commands/saveenv.c                              |   31 ++++-----
 commands/setenv.c                               |   30 ++++-----
 13 files changed, 161 insertions(+), 168 deletions(-)

Robert
-- 
Pengutronix e.K.                           | Dipl.-Ing. Robert Schwebel  |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 01/13] doc: remove obsolete link method for arch specification

[Robert Schwebel]

The cross_arch and cross_compile links method is obsolete and not
available any more, so we remove it from the documentation.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/building.dox |   14 ++++++--------
 1 files changed, 6 insertions(+), 8 deletions(-)

diff --git a/Documentation/building.dox b/Documentation/building.dox
index 895e9ac..527ca45 100644
--- a/Documentation/building.dox
+++ b/Documentation/building.dox
@@ -15,19 +15,17 @@ x86_64.
 
 \todo Find out about issues on x86_64.
 
-Selecting the architecture and the corresponding cross compiler can be
-done with two methods: You can either specify it using the environment
-variables @p ARCH and @p CROSS_COMPILE or you can create the soft links
-<i>cross_arch</i> and <i>cross_compile</i>, pointing to your
-architecture and compiler.
+Selecting the architecture and the corresponding cross compiler is done
+by setting the following environment variables:
 
-\todo How to use the links? This doesn't work!
+- ARCH=\<architecture>
+- CROSS_COMPILE=\<compiler-prefix>
 
 For @p ARCH=sandbox we do not need a cross compiler, so it is sufficient
 to specify the architecture:
 
 @code
-# ln -s arch/sandbox cross_arch
+# export ARCH=sandbox
 @endcode
 
 In order to configure the various aspects of @a barebox, start the
@@ -52,7 +50,7 @@ After @a barebox is configured, we can start the compilation:
 You can use '-j \<n\>' in order to do a parallel build if you have more
 than one cpus.
 
-If everything goes well, the result is a file called @p barebox: 
+If everything goes well, the result is a file called @p barebox:
 
 @code
 # ls -l barebox
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 02/13] doc: unify documentation for 'loadenv'

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 commands/loadenv.c |   34 ++++++++++++++--------------------
 1 files changed, 14 insertions(+), 20 deletions(-)

diff --git a/commands/loadenv.c b/commands/loadenv.c
index 14fbf1e..c33c34f 100644
--- a/commands/loadenv.c
+++ b/commands/loadenv.c
@@ -43,28 +43,22 @@ static int do_loadenv(struct command *cmdtp, int argc, char *argv[])
 	return envfs_load(filename, dirname);
 }
 
-static const __maybe_unused char cmd_loadenv_help[] =
-"Usage: loadenv [ENVFS] [DIRECTORY]\n"
-"Load the persistent storage contained in <envfs> to the directory\n"
-"<directory>.\n"
-"If ommitted <directory> defaults to /env and <envfs> defaults to /dev/env0.\n"
-"Note that envfs can only handle files. Directories are skipped silently.\n";
+BAREBOX_CMD_HELP_START(loadenv)
+BAREBOX_CMD_HELP_USAGE("loadenv [ENVFS] [DIRECTORY]\n")
+BAREBOX_CMD_HELP_SHORT("Load environment from ENVFS into DIRECTORY (default: /dev/env0 -> /env).\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page loadenv_command
+
+ENVFS can only handle files, directories are skipped silently.
+
+\todo This needs proper documentation. What is ENVFS, why is it FS etc. Explain the concepts.
+
+ */
 
 BAREBOX_CMD_START(loadenv)
 	.cmd		= do_loadenv,
-	.usage		= "load environment from persistent storage",
+	.usage		= "Load environment from ENVFS into DIRECTORY (default: /dev/env0 -> /env).",
 	BAREBOX_CMD_HELP(cmd_loadenv_help)
 BAREBOX_CMD_END
-
-/**
- * @page loadenv_command loadenv
- *
- * Usage: loadenv [\<directory>] [\<envfs>]
- *
- * Load the persistent storage contained in \<envfs> to the directory \<directory>.
- *
- * If ommitted \<directory> defaults to \c /env and \<envfs> defaults to
- * \c /dev/env0.
- *
- * @note envfs can only handle files. Directories are skipped silently.
- */
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 03/13] doc: remove ..., confuses doxygen

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 commands/ls.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/commands/ls.c b/commands/ls.c
index 2005178..4f9c408 100644
--- a/commands/ls.c
+++ b/commands/ls.c
@@ -195,7 +195,7 @@ static int do_ls(struct command *cmdtp, int argc, char *argv[])
 }
 
 BAREBOX_CMD_HELP_START(ls)
-BAREBOX_CMD_HELP_USAGE("ls [OPTION]... [FILE]...\n")
+BAREBOX_CMD_HELP_USAGE("ls [OPTIONS] [FILES]\n")
 BAREBOX_CMD_HELP_SHORT("List information about the FILEs (the current directory by default).\n")
 BAREBOX_CMD_HELP_OPT  ("-R",  "list subdirectories recursively\n")
 BAREBOX_CMD_HELP_END
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 04/13] doc: unify documentation for 'mount'

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 commands/mount.c |   78 +++++++++++++++++++++++++----------------------------
 1 files changed, 37 insertions(+), 41 deletions(-)

diff --git a/commands/mount.c b/commands/mount.c
index 8e4388e..52d1700 100644
--- a/commands/mount.c
+++ b/commands/mount.c
@@ -58,49 +58,45 @@ static int do_mount(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_mount_help[] =
-"Usage: mount:         list mounted filesystems\n"
-"or:    mount <device> <fstype> <mountpoint>\n"
-"\n"
-"Mount a filesystem of a given type to a mountpoint.\n"
-"<device> can be one of /dev/* or some arbitrary string if no\n"
-"device is needed for this driver (for example ramfs).\n"
-"<fstype> is the filesystem driver to use. Try the 'devinfo' command\n"
-"for a list of available drivers.\n"
-"<mountpoint> must be an empty directory descending directly from the\n"
-"root directory.\n";
+BAREBOX_CMD_HELP_START(mount)
+BAREBOX_CMD_HELP_USAGE("mount [<device> <fstype> <mountpoint>]\n")
+BAREBOX_CMD_HELP_SHORT("Mount a filesystem of a given type to a mountpoint.\n")
+BAREBOX_CMD_HELP_SHORT("If no argument is given, list mounted filesystems.\n")
+BAREBOX_CMD_HELP_END
 
-BAREBOX_CMD_START(mount)
-	.cmd		= do_mount,
-	.usage		= "mount a filesystem to a device",
-	BAREBOX_CMD_HELP(cmd_mount_help)
-BAREBOX_CMD_END
+/**
+ * @page mount_command
+
+<ul>
+<li>\<device> can be a device in /dev or some arbitrary string if no
+    device is needed for this driver, i.e. on ramfs. </li>
+<li>\<fstype> is the filesystem driver. A list of available drivers can
+    be shown with the \ref devinfo_command command.</li>
+<li>\<mountpoint> must be an empty directory, one level below the /
+    directory.</li>
+</ul>
 
-/** @page mount_command mount
- * Usage: mount [\<device> \<fstype> \<mountpoint>]
- *
- * Mounts a filesystem of a given \<fstype> on a \<device> to a \<mountpoint>.
- * \<device> can be one of /dev/ * or some arbitrary string if no
- * device is needed for this driver (for example ramfs).
- *
- * \<fstype> is the filesystem driver to use. Try the 'devinfo' command
- * for a list of available drivers.
- *
- * \<mountpoint> must be an empty directory descending directly from the
- * root directory.
  */
 
-/** @page how_mount_works How mount works in barebox
- *
- * Mounting a filesystem ontop of a device is working like devices and drivers
- * are finding together.
- *
- * The mount command creates a new device with the filesystem name as the
- * driver for this "device". So the framework is able to merge both parts
- * together.
- *
- * By the way: With this feature its impossible to accidentely remove
- * partitions in use. A partition is internally also a device. If its mounted
- * it will be marked as busy, so an delpart command fails, until the filesystem
- * has been unmounted.
+/**
+ * @page how_mount_works How mount works in barebox
+
+Mounting a filesystem ontop of a device is working like devices and
+drivers are finding together.
+
+The mount command creates a new device with the filesystem name as the
+driver for this "device". So the framework is able to merge both parts
+together.
+
+By the way: With this feature its impossible to accidentely remove
+partitions in use. A partition is internally also a device. If its
+mounted it will be marked as busy, so an delpart command fails, until
+the filesystem has been unmounted.
+
  */
+
+BAREBOX_CMD_START(mount)
+	.cmd		= do_mount,
+	.usage		= "Mount a filesystem of a given type to a mountpoint or list mounted filesystems.",
+	BAREBOX_CMD_HELP(cmd_mount_help)
+BAREBOX_CMD_END
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 05/13] doc: unify documentation for 'printenv'

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 commands/printenv.c |   30 +++++++++++++-----------------
 1 files changed, 13 insertions(+), 17 deletions(-)

diff --git a/commands/printenv.c b/commands/printenv.c
index e6fc0e4..4078bbc 100644
--- a/commands/printenv.c
+++ b/commands/printenv.c
@@ -65,26 +65,22 @@ static int do_printenv(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_printenv_help[] =
-"\n    - print values of all environment variables\n"
-"printenv name ...\n"
-"    - print value of environment variable 'name'\n";
+BAREBOX_CMD_HELP_START(printenv)
+BAREBOX_CMD_HELP_USAGE("printenv [variable]\n")
+BAREBOX_CMD_HELP_SHORT("Print value of one or all environment variables.\n")
+BAREBOX_CMD_HELP_END
 
+/**
+ * @page printenv_command
+
+<p>If an argument is given, printenv prints the content of an environment
+variable to the terminal. If no argument is specified, all variables are
+printed.</p>
+
+ */
 
 BAREBOX_CMD_START(printenv)
 	.cmd		= do_printenv,
-	.usage		= "print environment variables",
+	.usage		= "Print value of one or all environment variables.",
 	BAREBOX_CMD_HELP(cmd_printenv_help)
 BAREBOX_CMD_END
-
-/**
- * @page printenv_command printenv
- *
- * Usage: printenv [\<name>]
- *
- * Print environment variables.
- * If \<name> was given, it prints out its content if the environment variable
- * \<name> exists.
- *
- * Without the \<name> argument all current environment variables are printed.
- */
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 06/13] doc: unify documentation for 'protect' and 'unprotect'

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 commands/flash.c |   76 ++++++++++++++++++++++++++++++++----------------------
 1 files changed, 45 insertions(+), 31 deletions(-)

diff --git a/commands/flash.c b/commands/flash.c
index 4549f0a..c49de33 100644
--- a/commands/flash.c
+++ b/commands/flash.c
@@ -162,43 +162,57 @@ out:
 	return ret;
 }
 
-static const __maybe_unused char cmd_protect_help[] =
-"Usage: (un)protect <device> [area]\n"
-"(un)protect a flash device or parts of a device if an area specification\n"
-"is given\n";
+BAREBOX_CMD_HELP_START(protect)
+BAREBOX_CMD_HELP_USAGE("protect <device> [area]\n")
+BAREBOX_CMD_HELP_SHORT("protect a flash device (or parts of a device, if an area is specified)\n")
+BAREBOX_CMD_HELP_END
 
-BAREBOX_CMD_START(protect)
+BAREBOX_CMD_START(erase)
 	.cmd		= do_protect,
-	.usage		= "enable FLASH write protection",
+	.usage		= "enable flash write protection",
 	BAREBOX_CMD_HELP(cmd_protect_help)
 BAREBOX_CMD_END
 
-BAREBOX_CMD_START(unprotect)
-	.cmd		= do_protect,
-	.usage		= "disable FLASH write protection",
-	BAREBOX_CMD_HELP(cmd_protect_help)
-BAREBOX_CMD_END
+/**
+ * @page protect_command
+
+Protect the flash memory behind the device. It depends on the device
+given, what area will be protected. If the device represents the whole
+flash memory the whole memory will be protected. If the device
+represents a partition on a main flash memory, only this partition part
+will be protected.
+
+Refer addpart_command, delpart_command and devinfo_command for partition
+handling.
+
+\todo Rework this documentation, what is an 'area'? Explain more about
+flashes here.
 
-/** @page protect_command protect Protect a flash memory
- *
- * Usage is: protect \<devicee>
- *
- * Protect the flash memory behind the device. It depends on the device given,
- * what area will be protected. If the device represents the whole flash memory
- * the whole memory will be protected. If the device represents a partition on
- * a main flash memory, only this partition part will be protected.
- *
- * Refer \b addpart, \b delpart and \b devinfo for partition handling.
  */
 
-/** @page unprotect_command unprotect Unprotect a flash memory
- *
- * Usage is: unprotect \<devicee>
- *
- * Unprotect the flash memory behind the device. It depends on the device given,
- * what area will be unprotected. If the device represents the whole flash memory
- * the whole memory will be unprotected. If the device represents a partition
- * on a main flash memory, only this partition part will be unprotected.
- *
- * Refer \b addpart, \b delpart and \b devinfo for partition handling.
+BAREBOX_CMD_HELP_START(unprotect)
+BAREBOX_CMD_HELP_USAGE("unprotect <device> [area]\n")
+BAREBOX_CMD_HELP_SHORT("unprotect a flash device (or parts of a device, if an area is specified)\n")
+BAREBOX_CMD_HELP_END
+
+BAREBOX_CMD_START(erase)
+	.cmd		= do_unprotect,
+	.usage		= "enable flash write protection",
+	BAREBOX_CMD_HELP(cmd_unprotect_help)
+BAREBOX_CMD_END
+
+/**
+ * @page unprotect_command
+
+Unprotect the flash memory behind the device. It depends on the device given,
+what area will be unprotected. If the device represents the whole flash memory
+the whole memory will be unprotected. If the device represents a partition
+on a main flash memory, only this partition part will be unprotected.
+
+Refer addpart_command, delpart_command and devinfo_command for partition
+handling.
+
+\todo Rework this documentation, what does it mean?
+
  */
+
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 07/13] doc: unify documentation for 'saveenv'

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 commands/saveenv.c |   31 ++++++++++++++-----------------
 1 files changed, 14 insertions(+), 17 deletions(-)

diff --git a/commands/saveenv.c b/commands/saveenv.c
index 42ea58f..2f969fe 100644
--- a/commands/saveenv.c
+++ b/commands/saveenv.c
@@ -94,12 +94,10 @@ out:
 	return ret;
 }
 
-static const __maybe_unused char cmd_saveenv_help[] =
-"Usage: saveenv [<envfs>] [<directory>]\n"
-"Save the files in <directory> to the persistent storage device <envfs>.\n"
-"<envfs> is normally a block in flash, but could be any other file.\n"
-"If ommitted <directory> defaults to /env and <envfs> defaults to /dev/env0.\n"
-"Note that envfs can only handle files. Directories are skipped silently.\n";
+BAREBOX_CMD_HELP_START(saveenv)
+BAREBOX_CMD_HELP_USAGE("saveenv [envfs] [directory]\n")
+BAREBOX_CMD_HELP_SHORT("Save the files in <directory> to the persistent storage device <envfs>.\n")
+BAREBOX_CMD_HELP_END
 
 BAREBOX_CMD_START(saveenv)
 	.cmd		= do_saveenv,
@@ -108,15 +106,14 @@ BAREBOX_CMD_START(saveenv)
 BAREBOX_CMD_END
 
 /**
- * @page saveenv_command saveenv
- *
- * Usage: saveenv [\<envfs>] [\<directory>]
- *
- * Save the files in \<directory> to the persistent storage device \<envfs>.
- * \<envfs> is normally a block in flash, but could be any other file.
- *
- * If ommitted \<directory> defaults to \c /env and \<envfs> defaults to
- * \c /dev/env0.
- *
- * @note envfs can only handle files. Directories are skipped silently.
+ * @page saveenv_command
+
+<p>\<envfs> is usually a block in flash but can be any other file. If
+ommitted, \<directory> defaults to /env and \<envfs> defaults to
+/dev/env0. Note that envfs can only handle files, directories are being
+skipped silently.</p>
+
+\todo What does 'block in flash' mean? Add example.
+
  */
+
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 08/13] doc: unify documentation for 'setenv'

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 commands/setenv.c |   30 +++++++++++++-----------------
 1 files changed, 13 insertions(+), 17 deletions(-)

diff --git a/commands/setenv.c b/commands/setenv.c
index 257348f..e39db20 100644
--- a/commands/setenv.c
+++ b/commands/setenv.c
@@ -38,27 +38,23 @@ static int do_setenv(struct command *cmdtp, int argc, char *argv[])
 	return 0;
 }
 
-static const __maybe_unused char cmd_setenv_help[] =
-"name value ...\n"
-"    - set environment variable 'name' to 'value ...'\n"
-"setenv name\n"
-"    - delete environment variable 'name'\n";
+BAREBOX_CMD_HELP_START(setenv)
+BAREBOX_CMD_HELP_USAGE("setenv <name> [<value>]\n")
+BAREBOX_CMD_HELP_SHORT("Set environment variable to a value or delete if value is avoided.\n")
+BAREBOX_CMD_HELP_END
 
+/**
+ * @page setenv_command
+
+<p> This command is only available if the simple command line parser is
+in use. Within the hush shell, \c setenv is not required.</p>
+
+\todo Check if kconfig does this correctly.
+
+ */
 
 BAREBOX_CMD_START(setenv)
 	.cmd		= do_setenv,
 	.usage		= "set environment variables",
 	BAREBOX_CMD_HELP(cmd_setenv_help)
 BAREBOX_CMD_END
-
-/**
- * @page setenv_command setenv: set an environment variable
- *
- * Usage: setenv \<name> [\<value>]
- *
- * Set environment variable \<name> to \<value>. Without a given value, the
- * environment variable will be deleted.
- *
- * @note This command is only available if the simple command line parser is
- * in use. Within the hush shell \c setenv is not required.
- */
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 09/13] doc: remove sh from command documentation

[Robert Schwebel]

Hush documentation is a nightmare, so remove sh documentation from the
command index. This needs proper rework for all of the hush commands.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/commands.dox |    1 -
 1 files changed, 0 insertions(+), 1 deletions(-)

diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 2b949f7..27eb511 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -42,7 +42,6 @@ available in @a Barebox:
 @li @subpage protect_command
 @li @subpage saveenv_command
 @li @subpage setenv_command
-@li @subpage sh_command
 @li @subpage unprotect_command
 @li @subpage linux16_command
 
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 10/13] doc: unify documentation for 'linux16'

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 commands/linux16.c |   25 ++++++++++++-------------
 1 files changed, 12 insertions(+), 13 deletions(-)

diff --git a/commands/linux16.c b/commands/linux16.c
index b15812f..ec859a7 100644
--- a/commands/linux16.c
+++ b/commands/linux16.c
@@ -288,14 +288,22 @@ on_error:
 	return rc;
 }
 
-static const __maybe_unused char cmd_linux16_help[] =
-"Usage: linux16 <file>\n"
-"Boot a linux kernel via real mode code\n";
+BAREBOX_CMD_HELP_START(linux16)
+BAREBOX_CMD_HELP_USAGE("linux16 <file>\n")
+BAREBOX_CMD_HELP_SHORT("Boot a kernel on x86 via real mode code.\n")
+BAREBOX_CMD_HELP_END
 
+/**
+ * @page linux16_command
+
+<p> Only kernel images in bzImage format are supported by now. See \ref
+x86_boot_preparation for more info about how to use this command.</p>
+
+ */
 
 BAREBOX_CMD_START(linux16)
 	.cmd		= do_linux16,
-	.usage		= "boot linux kernel",
+	.usage		= "boot a linux kernel",
 	BAREBOX_CMD_HELP(cmd_linux16_help)
 BAREBOX_CMD_END
 
@@ -305,15 +313,6 @@ BAREBOX_CMD_END
  */
 
 /**
- * @page linux16_command linux16: Boot a bzImage kernel on x86
- *
- * Usage is: linux16 \<file\>
- *
- * Boot a linux kernel via real mode code. Only kernel images in the
- * @p bzImage format are supported.
- */
-
-/**
  * @page x86_boot_preparation Linux Preparation on x86
  *
  * Due to some real mode constraints, starting Linux is somehow tricky.
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 11/13] doc: put CPUIMX35 into the right chapter

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/boards.dox |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)

diff --git a/Documentation/boards.dox b/Documentation/boards.dox
index 0b7a198..8b52d2e 100644
--- a/Documentation/boards.dox
+++ b/Documentation/boards.dox
@@ -8,6 +8,7 @@ PowerPC type:
 
 ARM type:
 
+
 @li @subpage pcm037
 @li @subpage pcm038
 @li @subpage pcm043
@@ -22,6 +23,7 @@ ARM type:
 @li @subpage a9m2440
 @li @subpage a9m2410
 @li @subpage eukrea_cpuimx27
+@li @subpage eukrea_cpuimx35
 @li @subpage edb9301
 @li @subpage edb9302
 @li @subpage edb9302a
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 12/13] doc: put babage board into the right chapter

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/boards.dox                        |    1 +
 arch/arm/boards/freescale-mx51-pdk/mx51-pdk.dox |    2 +-
 2 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/Documentation/boards.dox b/Documentation/boards.dox
index 8b52d2e..02e02bd 100644
--- a/Documentation/boards.dox
+++ b/Documentation/boards.dox
@@ -16,6 +16,7 @@ ARM type:
 @li @subpage imx27ads
 @li @subpage the3stack
 @li @subpage mx23_evk
+@li @subpage board_babage
 @li @subpage chumbyone
 @li @subpage scb9328
 @li @subpage netx
diff --git a/arch/arm/boards/freescale-mx51-pdk/mx51-pdk.dox b/arch/arm/boards/freescale-mx51-pdk/mx51-pdk.dox
index 7d04df6..d9ea823 100644
--- a/arch/arm/boards/freescale-mx51-pdk/mx51-pdk.dox
+++ b/arch/arm/boards/freescale-mx51-pdk/mx51-pdk.dox
@@ -1,4 +1,4 @@
-/** @page Freescale i.MX51 PDK (Babbage) Board
+/** @page board_babage Freescale i.MX51 PDK (Babbage) Board
 
 
 */
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 13/13] doc: put cupid into the right chapter

[Robert Schwebel]

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 Documentation/boards.dox            |    1 +
 arch/arm/boards/guf-cupid/cupid.dox |    2 +-
 2 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/Documentation/boards.dox b/Documentation/boards.dox
index 02e02bd..fa0f284 100644
--- a/Documentation/boards.dox
+++ b/Documentation/boards.dox
@@ -33,6 +33,7 @@ ARM type:
 @li @subpage edb9312
 @li @subpage edb9315
 @li @subpage edb9315a
+@li @subpage board_cupid
 
 Blackfin type:
 
diff --git a/arch/arm/boards/guf-cupid/cupid.dox b/arch/arm/boards/guf-cupid/cupid.dox
index 2ff1b2c..45f0e0c 100644
--- a/arch/arm/boards/guf-cupid/cupid.dox
+++ b/arch/arm/boards/guf-cupid/cupid.dox
@@ -1,4 +1,4 @@
-/** @page Garz+Fricke Cupid
+/** @page board_cupid Garz+Fricke Cupid
 
 This CPU card is based on a Freescale i.MX35 CPU. The card is shipped with:
 
-- 
1.7.2.3


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Documentation Updates

[Robert Schwebel]

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


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox