9
0
Fork 0
Commit Graph

20 Commits

Author SHA1 Message Date
Robert Schwebel 4ce5028ecd doc: put barebox version into documentation
Currently the documentation does always claim to be version 1. We add
the revision plus the git version to the manual.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
2010-11-15 09:57:26 +01:00
Robert Schwebel b8315d622d doc: unify documentation for 'tftp'
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
2010-11-01 16:23:09 +01:00
Robert Schwebel 681f821d05 doc: unify documentation for 'devinfo'
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
2010-11-01 16:23:09 +01:00
Robert Schwebel 511c5d8d0c doc: add macros to unify command help with doxygen
Currently we have duplicated all the information that appears online in
'help <command>' and in the doxygen documentation. This patch adds some
infrastructure to specify help texts only once and re-use them for the
integrated help as well as for the manual.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
2010-11-01 16:23:08 +01:00
Robert Schwebel facf3ccba4 Doxyfile: enable assembler files
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2010-10-22 20:47:02 +02:00
Robert Schwebel e828c42484 Doxyfile: remove unused features
Disable callgraph and friends, we don't use them anyway.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2010-10-22 20:47:02 +02:00
Robert Schwebel 31afde4c09 Doxyfile: remove non-existing directories
The example and image directories are currently not used, so we remove
the references from the Doxyfile. Silences a doxygen warning.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2010-10-22 20:47:02 +02:00
Robert Schwebel 7865b3de2a Doxyfile: add exclude rules
The mtd stuff copied from linux and elsewhere contains commands which
are not understood by a 'real' doxygen. For now, we add exclude rules.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2010-10-22 20:47:02 +02:00
Robert Schwebel f72f32768b Doxyfile: remove obsolete boards directory
This directory does not exist any more, so we can remove it. Silences a
doxygen warning.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2010-10-22 20:47:02 +02:00
Robert Schwebel c085d2e64d Doxyfile: enable quiet output
We set the output to "quiet" in order to see the warnings.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2010-10-22 20:47:02 +02:00
Sascha Hauer 232b46996c add netconsole support
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2010-06-17 08:28:29 +02:00
Juergen Beisert 5d591e14ef Add a tool to activate barebox as a boot loader on x86 architectures
To use barebox as a BIOS based bootloader for x86 architectures, the binary
must be patched to get it bootstrapped at runtime. The 'setupmbr' tool installs
the barebox-binary to the given device node or image file and patch it in
accordance to the needed sector information at runtime.

Signed-off by: Juergen Beisert <jbe@pengutronix.de>

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2010-01-14 10:06:15 +01:00
Juergen Beisert dac84c7b9d documentation updates
Signed-off-by: Juergen Beisert <jbe@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2009-12-15 11:32:02 +01:00
Sascha Hauer a3ffa97f40 rename U-Boot-v2 project to barebox
This has been done with the following script:

find -path ./.git -prune -o -type f -print0 | xargs -0 -r sed -i \
	-e 's/u2boot/barebox/g' \
	-e 's/U2Boot/barebox/g' \
	-e 's/U-boot V2/barebox/g' \
	-e 's/u-boot v2/barebox/g' \
	-e 's/U-Boot V2/barebox/g' \
	-e 's/U-Boot-v2/barebox/g' \
	-e 's/U_BOOT/BAREBOX/g' \
	-e 's/UBOOT/BAREBOX/g' \
	-e 's/uboot/barebox/g' \
	-e 's/u-boot/barebox/g' \
	-e 's/u_boot/barebox/g' \
	-e 's/U-Boot/barebox/g' \
	-e 's/U-boot/barebox/g' \
	-e 's/U-BOOT/barebox/g'

find -path ./.git -prune -o \( -name "*u-boot*" -o -name "*uboot*" -o -name "*u_boot*" \) -print0 | \
	xargs -0 -r rename 's/u[-_]?boot/barebox/'

It needs some manual fixup following in the next patch

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2009-12-15 10:18:30 +01:00
Sascha Hauer 9c9f3ffd16 Doxygen cleanups
- Remove trailing whitespaces from doxygen files
- escape '<' '>' with backslashes. Otherwise Doxygen interpretes them as
  html tags

Signed-off-by: Carsten Schlote <schlote@vahanus.net>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2008-04-04 14:45:04 +02:00
Juergen Beisert 4cd877a840 saving added docu 2007-11-05 14:39:07 +01:00
Juergen Beisert d24db665ac manual org added 2007-10-19 22:16:16 +02:00
Juergen Beisert 30e09b83d5 shell info added 2007-10-19 21:35:46 +02:00
Juergen Beisert b21ed7177c basic doc structure added 2007-10-19 13:19:43 +02:00
Juergen Beisert 93229c846d adding doxygen's base configuration 2007-10-19 11:38:42 +02:00