* [PATCH 01/32] reset_cpu: unify declaration
2010-10-22 16:44 Documentation Updates Robert Schwebel
@ 2010-10-22 16:44 ` Robert Schwebel
2010-10-22 16:44 ` [PATCH 02/32] Doxyfile: enable quiet output Robert Schwebel
` (30 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:44 UTC (permalink / raw)
To: barebox
include/common.h declares this as "unsigned long addr", so we unify it.
This also silences a doxygen warning.
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
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/omap3_generic.c | 4 ++--
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 +-
9 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/arch/arm/mach-at91/at91sam926x_time.c b/arch/arm/mach-at91/at91sam926x_time.c
index 84df1a1..c1b42f9 100644
--- a/arch/arm/mach-at91/at91sam926x_time.c
+++ b/arch/arm/mach-at91/at91sam926x_time.c
@@ -73,7 +73,7 @@ core_initcall(clocksource_init);
/*
* Reset the cpu through the reset controller
*/
-void __noreturn reset_cpu (unsigned long ignored)
+void __noreturn reset_cpu (unsigned long addr)
{
at91_sys_write(AT91_RSTC_CR, AT91_RSTC_KEY |
AT91_RSTC_PROCRST |
diff --git a/arch/arm/mach-ep93xx/clocksource.c b/arch/arm/mach-ep93xx/clocksource.c
index 3aa8e14..a1e315d 100644
--- a/arch/arm/mach-ep93xx/clocksource.c
+++ b/arch/arm/mach-ep93xx/clocksource.c
@@ -72,7 +72,7 @@ core_initcall(clocksource_init);
/*
* Reset the cpu
*/
-void __noreturn reset_cpu(unsigned long ignored)
+void __noreturn reset_cpu(unsigned long addr)
{
struct syscon_regs *syscon = (struct syscon_regs *)SYSCON_BASE;
uint32_t value;
diff --git a/arch/arm/mach-imx/clocksource.c b/arch/arm/mach-imx/clocksource.c
index b8101e9..5b1bad5 100644
--- a/arch/arm/mach-imx/clocksource.c
+++ b/arch/arm/mach-imx/clocksource.c
@@ -118,7 +118,7 @@ core_initcall(clocksource_init);
/*
* Reset the cpu by setting up the watchdog timer and let it time out
*/
-void __noreturn reset_cpu (unsigned long ignored)
+void __noreturn reset_cpu (unsigned long addr)
{
/* Disable watchdog and set Time-Out field to 0 */
writew(0x0, IMX_WDT_BASE + WDOG_WCR);
diff --git a/arch/arm/mach-omap/omap3_generic.c b/arch/arm/mach-omap/omap3_generic.c
index 9893145..f780794 100644
--- a/arch/arm/mach-omap/omap3_generic.c
+++ b/arch/arm/mach-omap/omap3_generic.c
@@ -52,11 +52,11 @@
*
* In case of crashes, reset the CPU
*
- * @param[in] addr -Cause of crash
+ * @param addr Cause of crash
*
* @return void
*/
-void __noreturn reset_cpu(ulong addr)
+void __noreturn reset_cpu(unsigned long addr)
{
/* FIXME: Enable WDT and cause reset */
hang();
diff --git a/arch/arm/mach-stm/reset-imx23.c b/arch/arm/mach-stm/reset-imx23.c
index db0b3f2..b35f796 100644
--- a/arch/arm/mach-stm/reset-imx23.c
+++ b/arch/arm/mach-stm/reset-imx23.c
@@ -48,7 +48,7 @@
* TODO There is a much easier way to reset the CPU: Refer bit 2 in
* the HW_CLKCTRL_RESET register, data sheet page 106/4-30
*/
-void __noreturn reset_cpu (unsigned long ignored)
+void __noreturn reset_cpu (unsigned long addr)
{
writel(WDOG_COUNTER_RATE, IMX_WDT_BASE + HW_RTC_WATCHDOG);
writel(BM_RTC_CTRL_WATCHDOGEN, IMX_WDT_BASE + HW_RTC_CTRL_SET);
diff --git a/arch/blackfin/lib/cpu.c b/arch/blackfin/lib/cpu.c
index f96d22d..aed0864 100644
--- a/arch/blackfin/lib/cpu.c
+++ b/arch/blackfin/lib/cpu.c
@@ -32,7 +32,7 @@
#include <asm/cpu.h>
#include <init.h>
-void __noreturn reset_cpu(ulong ignored)
+void __noreturn reset_cpu(unsigned long addr)
{
icache_disable();
diff --git a/arch/m68k/mach-mcfv4e/mcf_reset_cpu.c b/arch/m68k/mach-mcfv4e/mcf_reset_cpu.c
index 3b1a25b..d4659d2 100644
--- a/arch/m68k/mach-mcfv4e/mcf_reset_cpu.c
+++ b/arch/m68k/mach-mcfv4e/mcf_reset_cpu.c
@@ -27,7 +27,7 @@
/**
* Reset the cpu by setting up the watchdog timer and let it time out
*/
-void __noreturn reset_cpu (unsigned long ignored)
+void __noreturn reset_cpu (unsigned long addr)
{
while ( ignored ) { ; };
diff --git a/arch/ppc/mach-mpc5xxx/cpu.c b/arch/ppc/mach-mpc5xxx/cpu.c
index 7ee1954..4d08c55 100644
--- a/arch/ppc/mach-mpc5xxx/cpu.c
+++ b/arch/ppc/mach-mpc5xxx/cpu.c
@@ -71,7 +71,7 @@ int checkcpu (void)
/* ------------------------------------------------------------------------- */
-void __noreturn reset_cpu (unsigned long unused)
+void __noreturn reset_cpu (unsigned long addr)
{
ulong msr;
/* Interrupts and MMU off */
diff --git a/arch/sandbox/os/common.c b/arch/sandbox/os/common.c
index 89b2e5c..287be0d 100644
--- a/arch/sandbox/os/common.c
+++ b/arch/sandbox/os/common.c
@@ -138,7 +138,7 @@ uint64_t linux_get_time(void)
return now;
}
-void __attribute__((noreturn)) reset_cpu(int unused)
+void __attribute__((noreturn)) reset_cpu(unsigned long addr)
{
cookmode();
exit(0);
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 02/32] Doxyfile: enable quiet output
2010-10-22 16:44 Documentation Updates Robert Schwebel
2010-10-22 16:44 ` [PATCH 01/32] reset_cpu: unify declaration Robert Schwebel
@ 2010-10-22 16:44 ` Robert Schwebel
2010-10-22 16:44 ` [PATCH 03/32] Doxyfile: remove obsolete boards directory Robert Schwebel
` (29 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:44 UTC (permalink / raw)
To: barebox
We set the output to "quiet" in order to see the warnings.
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Doxyfile | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/Doxyfile b/Doxyfile
index 40bcb2f..6c04afe 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -424,7 +424,7 @@ FILE_VERSION_FILTER =
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
-QUIET = NO
+QUIET = YES
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 03/32] Doxyfile: remove obsolete boards directory
2010-10-22 16:44 Documentation Updates Robert Schwebel
2010-10-22 16:44 ` [PATCH 01/32] reset_cpu: unify declaration Robert Schwebel
2010-10-22 16:44 ` [PATCH 02/32] Doxyfile: enable quiet output Robert Schwebel
@ 2010-10-22 16:44 ` Robert Schwebel
2010-10-22 16:44 ` [PATCH 04/32] Doxyfile: add exclude rules Robert Schwebel
` (28 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:44 UTC (permalink / raw)
To: barebox
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>
---
Doxyfile | 1 -
1 files changed, 0 insertions(+), 1 deletions(-)
diff --git a/Doxyfile b/Doxyfile
index 6c04afe..4fc9834 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -483,7 +483,6 @@ INPUT = Documentation \
drivers \
commands \
common \
- board \
lib \
scripts/setupmbr \
net
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 04/32] Doxyfile: add exclude rules
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (2 preceding siblings ...)
2010-10-22 16:44 ` [PATCH 03/32] Doxyfile: remove obsolete boards directory Robert Schwebel
@ 2010-10-22 16:44 ` Robert Schwebel
2010-10-22 16:44 ` [PATCH 05/32] Doxyfile: remove non-existing directories Robert Schwebel
` (27 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:44 UTC (permalink / raw)
To: barebox
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>
---
Doxyfile | 4 +++-
1 files changed, 3 insertions(+), 1 deletions(-)
diff --git a/Doxyfile b/Doxyfile
index 4fc9834..46f086c 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -515,7 +515,9 @@ RECURSIVE = YES
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
-EXCLUDE =
+EXCLUDE = drivers/mtd/ubi \
+ include/mtd \
+ include/linux/mtd
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 05/32] Doxyfile: remove non-existing directories
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (3 preceding siblings ...)
2010-10-22 16:44 ` [PATCH 04/32] Doxyfile: add exclude rules Robert Schwebel
@ 2010-10-22 16:44 ` Robert Schwebel
2010-10-22 16:44 ` [PATCH 06/32] Doxyfile: remove unused features Robert Schwebel
` (26 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:44 UTC (permalink / raw)
To: barebox
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>
---
Doxyfile | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/Doxyfile b/Doxyfile
index 46f086c..21a6212 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -544,7 +544,7 @@ EXCLUDE_SYMBOLS =
# directories that contain example code fragments that are included (see
# the \include command).
-EXAMPLE_PATH = Documentation/examples/
+EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -564,7 +564,7 @@ EXAMPLE_RECURSIVE = NO
# directories that contain image that are included in the documentation (see
# the \image command).
-IMAGE_PATH = Documentation/images/
+IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 06/32] Doxyfile: remove unused features
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (4 preceding siblings ...)
2010-10-22 16:44 ` [PATCH 05/32] Doxyfile: remove non-existing directories Robert Schwebel
@ 2010-10-22 16:44 ` Robert Schwebel
2010-10-22 16:44 ` [PATCH 07/32] Doxyfile: enable assembler files Robert Schwebel
` (25 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:44 UTC (permalink / raw)
To: barebox
Disable callgraph and friends, we don't use them anyway.
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Doxyfile | 8 ++++----
1 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/Doxyfile b/Doxyfile
index 21a6212..37597f6 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -1210,7 +1210,7 @@ INCLUDED_BY_GRAPH = NO
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command.
-CALL_GRAPH = YES
+CALL_GRAPH = NO
# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
# generate a caller dependency graph for every global function or class method.
@@ -1218,19 +1218,19 @@ CALL_GRAPH = YES
# So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command.
-CALLER_GRAPH = YES
+CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.
-GRAPHICAL_HIERARCHY = YES
+GRAPHICAL_HIERARCHY = NO
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
# then doxygen will show the dependencies a directory has on other directories
# in a graphical way. The dependency relations are determined by the #include
# relations between the files in the directories.
-DIRECTORY_GRAPH = YES
+DIRECTORY_GRAPH = NO
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are png, jpg, or gif
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 07/32] Doxyfile: enable assembler files
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (5 preceding siblings ...)
2010-10-22 16:44 ` [PATCH 06/32] Doxyfile: remove unused features Robert Schwebel
@ 2010-10-22 16:44 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 08/32] doc: let doxygen find some assembler functions Robert Schwebel
` (24 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:44 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Doxyfile | 1 +
1 files changed, 1 insertions(+), 0 deletions(-)
diff --git a/Doxyfile b/Doxyfile
index 37597f6..912abc1 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -503,6 +503,7 @@ INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \
*.h \
+ *.S \
*.dox
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 08/32] doc: let doxygen find some assembler functions
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (6 preceding siblings ...)
2010-10-22 16:44 ` [PATCH 07/32] Doxyfile: enable assembler files Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 09/32] doc: remove nonexisting command Robert Schwebel
` (23 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Silences these warnings:
arch/x86/boot/boot_hdisk.S:29: Warning: documented function `void real_start' was not declared or defined.
arch/x86/boot/boot_main.S:28: Warning: documented function `void _start' was not declared or defined.
arch/x86/boot/pmjump.S:20: Warning: documented function `void protected_mode_jump' was not declared or defined.
arch/x86/lib/memory16.S:32: Warning: documented function `unsigned short bios_get_memsize' was not declared or defined.
arch/x86/lib/traveler.S:31: Warning: documented function `void real_to_prot' was not declared or defined.
arch/x86/lib/traveler.S:38: Warning: documented function `void prot_to_real' was not declared or defined.
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
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 ---
5 files changed, 0 insertions(+), 11 deletions(-)
diff --git a/arch/x86/boot/boot_hdisk.S b/arch/x86/boot/boot_hdisk.S
index 40388e9..fc4c4d5 100644
--- a/arch/x86/boot/boot_hdisk.S
+++ b/arch/x86/boot/boot_hdisk.S
@@ -31,7 +31,6 @@
* from the boot media.
*/
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
.file "boot_hdisk.S"
.code16
@@ -173,4 +172,3 @@ notification_string: .asciz "UBOOT2 "
chs_string: .asciz "CHS "
jmp_string: .asciz "JMP "
-#endif
diff --git a/arch/x86/boot/boot_main.S b/arch/x86/boot/boot_main.S
index f3d248a..94fe434 100644
--- a/arch/x86/boot/boot_main.S
+++ b/arch/x86/boot/boot_main.S
@@ -30,7 +30,6 @@
* @brief Fix segment:offset settings of some buggy BIOSs
*/
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
.file "boot_main.S"
.code16
@@ -55,4 +54,3 @@ _start:
.size _start, .-_start
-#endif
diff --git a/arch/x86/boot/pmjump.S b/arch/x86/boot/pmjump.S
index d48e198..0e4cd38 100644
--- a/arch/x86/boot/pmjump.S
+++ b/arch/x86/boot/pmjump.S
@@ -20,7 +20,6 @@
* @fn void protected_mode_jump(void)
* @brief Switches the first time from real mode to flat mode
*/
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
#include <asm/modes.h>
#include "boot.h"
@@ -86,4 +85,3 @@ in_pm32:
.size protected_mode_jump, .-protected_mode_jump
-#endif
diff --git a/arch/x86/lib/memory16.S b/arch/x86/lib/memory16.S
index 01450fa..cb2f833 100644
--- a/arch/x86/lib/memory16.S
+++ b/arch/x86/lib/memory16.S
@@ -38,7 +38,6 @@
*
*/
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
.section .boot.text.bios_get_memsize, "ax"
.code32
@@ -70,4 +69,3 @@ bios_get_memsize:
.size bios_get_memsize, .-bios_get_memsize
-#endif
diff --git a/arch/x86/lib/traveler.S b/arch/x86/lib/traveler.S
index 2b6dc85..0614195 100644
--- a/arch/x86/lib/traveler.S
+++ b/arch/x86/lib/traveler.S
@@ -41,8 +41,6 @@
* Called from a 16 bit real mode segment and returns into a 32 bit segment
*/
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include <asm/modes.h>
.file "walkyrie.S"
@@ -180,4 +178,3 @@ enter_realmode:
.size prot_to_real, .-prot_to_real
-#endif
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 09/32] doc: remove nonexisting command
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (7 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 08/32] doc: let doxygen find some assembler functions Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 10/32] doc: remove reference to non-existing documentation Robert Schwebel
` (22 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Silence this warning:
Documentation/commands.dox:24: Warning: unable to resolve reference to `rarp_command' for \ref command
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 a8850b1..5404483 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -15,7 +15,6 @@
@li @subpage mount_command
@li @subpage printenv_command
@li @subpage protect_command
-@li @subpage rarp_command
@li @subpage saveenv_command
@li @subpage setenv_command
@li @subpage sh_command
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 10/32] doc: remove reference to non-existing documentation
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (8 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 09/32] doc: remove nonexisting command Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 11/32] doc: eliminate nonexisting reference Robert Schwebel
` (21 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Silence this warning:
Documentation/users_manual.dox:10: Warning: unable to resolve reference to `partitions' for \ref command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Documentation/users_manual.dox | 1 -
1 files changed, 0 insertions(+), 1 deletions(-)
diff --git a/Documentation/users_manual.dox b/Documentation/users_manual.dox
index cd2b99c..0a0a13e 100644
--- a/Documentation/users_manual.dox
+++ b/Documentation/users_manual.dox
@@ -9,7 +9,6 @@ work easier.
@li @subpage shell_notes
@li @subpage readline_parser
@li @subpage command_reference
-@li @subpage partitions
@li @subpage x86_bootloader
@li @subpage net_netconsole
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 11/32] doc: eliminate nonexisting reference
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (9 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 10/32] doc: remove reference to non-existing documentation Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 12/32] doc: add missing quoting Robert Schwebel
` (20 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Silence this warning:
arch/architecture.dox:89: Warning: unable to resolve reference to `dev_x86_mach' for \ref command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Documentation/developers_manual.dox | 1 -
arch/x86/mach-x86.dox | 2 +-
2 files changed, 1 insertions(+), 2 deletions(-)
diff --git a/Documentation/developers_manual.dox b/Documentation/developers_manual.dox
index 620905e..2f7d360 100644
--- a/Documentation/developers_manual.dox
+++ b/Documentation/developers_manual.dox
@@ -20,6 +20,5 @@ This part of the documentation is intended for developers of @a barebox.
@li @subpage barebox_simul
@li @subpage io_access_functions
@li @subpage mcfv4e_MCDlib
-@li @subpage x86_runtime
*/
diff --git a/arch/x86/mach-x86.dox b/arch/x86/mach-x86.dox
index fc5b85a..661e905 100644
--- a/arch/x86/mach-x86.dox
+++ b/arch/x86/mach-x86.dox
@@ -2,7 +2,7 @@
* how to integrate a new CPU (MACH) into this part of the barebox tree
*/
-/** @page x86_runtime barebox on x86 at runtime
+/** @page dev_x86_mach barebox on x86 at runtime
@section mach_x86_memory_layout barebox's memory layout (BIOS based)
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 12/32] doc: add missing quoting
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (10 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 11/32] doc: eliminate nonexisting reference Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 13/32] doc: fix typo Robert Schwebel
` (19 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Silence this warning:
/home/rsc/git/barebox/commands/partition.c:177: Warning: Found unknown command `\offset1'
/home/rsc/git/barebox/commands/partition.c:177: Warning: Found unknown command `\offset2'
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
commands/partition.c | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/commands/partition.c b/commands/partition.c
index 7794925..a1edcf6 100644
--- a/commands/partition.c
+++ b/commands/partition.c
@@ -176,7 +176,7 @@ BAREBOX_CMD_END
* Adds a partition description to a device. The partition description has the
* form
*
- * size1[@offset1](name1)[ro],size2[@offset2](name2)[ro],...
+ * size1[\@offset1](name1)[ro],size2[\@offset2](name2)[ro],...
*
* \<device> is the device name under. Size and offset can be given in decimal
* or - if prefixed with 0x - in hex. Both can have an optional suffix K,M,G.
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 13/32] doc: fix typo
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (11 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 12/32] doc: add missing quoting Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 17:21 ` Juergen Beisert
2010-10-22 16:45 ` [PATCH 14/32] doc: mark code explicitely Robert Schwebel
` (18 subsequent siblings)
31 siblings, 1 reply; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Remove a # which leads to this warning:
arch/arm/mach-s3c24xx/lowlevel-init.S:307: Warning: explicit link request to 'CALC_NFCONF_TIMING' could not be resolved
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
arch/arm/mach-s3c24xx/lowlevel-init.S | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/arch/arm/mach-s3c24xx/lowlevel-init.S b/arch/arm/mach-s3c24xx/lowlevel-init.S
index e8004e5..27f3a32 100644
--- a/arch/arm/mach-s3c24xx/lowlevel-init.S
+++ b/arch/arm/mach-s3c24xx/lowlevel-init.S
@@ -304,7 +304,7 @@ minimalistic. Setup the NAND access timing is done in a safe manner, what
means: Slowest possible values are used. If you want to increase the speed you
should define the BOARD_DEFAULT_NAND_TIMING to a valid setting into the
NFCONF register and add it to your board specific config.h. Refer S3C24x0's
-datasheet for further details. The macro #CALC_NFCONF_TIMING could help to
+datasheet for further details. The macro CALC_NFCONF_TIMING could help to
calculate the register setting in a hardware independent manner.
@note The regular NAND driver uses a platform data structure to define the
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* Re: [PATCH 13/32] doc: fix typo
2010-10-22 16:45 ` [PATCH 13/32] doc: fix typo Robert Schwebel
@ 2010-10-22 17:21 ` Juergen Beisert
0 siblings, 0 replies; 35+ messages in thread
From: Juergen Beisert @ 2010-10-22 17:21 UTC (permalink / raw)
To: barebox
Robert Schwebel wrote:
> Remove a # which leads to this warning:
> arch/arm/mach-s3c24xx/lowlevel-init.S:307: Warning: explicit link request
> to 'CALC_NFCONF_TIMING' could not be resolved
>
> Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
> ---
> arch/arm/mach-s3c24xx/lowlevel-init.S | 2 +-
> 1 files changed, 1 insertions(+), 1 deletions(-)
>
> diff --git a/arch/arm/mach-s3c24xx/lowlevel-init.S
> b/arch/arm/mach-s3c24xx/lowlevel-init.S index e8004e5..27f3a32 100644
> --- a/arch/arm/mach-s3c24xx/lowlevel-init.S
> +++ b/arch/arm/mach-s3c24xx/lowlevel-init.S
> @@ -304,7 +304,7 @@ minimalistic. Setup the NAND access timing is done in a
> safe manner, what means: Slowest possible values are used. If you want to
> increase the speed you should define the BOARD_DEFAULT_NAND_TIMING to a
> valid setting into the NFCONF register and add it to your board specific
> config.h. Refer S3C24x0's -datasheet for further details. The macro
> #CALC_NFCONF_TIMING could help to +datasheet for further details. The macro
> CALC_NFCONF_TIMING could help to calculate the register setting in a
> hardware independent manner.
>
> @note The regular NAND driver uses a platform data structure to define the
Hmm, but this macro exists and doxygen should generate a reference to it.
Don't know why it spits out a warning here.
jbe
--
Pengutronix e.K. | Juergen Beisert |
Linux Solutions for Science and Industry | Phone: +49-8766-939 228 |
Vertretung Sued/Muenchen, Germany | Fax: +49-5121-206917-5555 |
Amtsgericht Hildesheim, HRA 2686 | http://www.pengutronix.de/ |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread
* [PATCH 14/32] doc: mark code explicitely
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (12 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 13/32] doc: fix typo Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 15/32] doc: avoid that doxygen parses magic in command.h Robert Schwebel
` (17 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Silence this warning:
arch/arm/mach-omap/arch-omap.dox:51: Warning: explicit link request to 'define' could not be resolved
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
arch/arm/mach-omap/arch-omap.dox | 6 +++++-
1 files changed, 5 insertions(+), 1 deletions(-)
diff --git a/arch/arm/mach-omap/arch-omap.dox b/arch/arm/mach-omap/arch-omap.dox
index df16b7b..9c90b4f 100644
--- a/arch/arm/mach-omap/arch-omap.dox
+++ b/arch/arm/mach-omap/arch-omap.dox
@@ -50,7 +50,11 @@ All basic devices you'd like to register should be put here with postcore_initca
All OMAP common headers are located here. Where we have to incorporate a OMAP variant specific header, add a omapX_function_name.h.
@warning Do not add board specific header files/information here. Put them in mach-omap.
-include/asm-arm/arch-omap/silicon.h contains includes for omapX-silicon.h which defines the base addresses for the peripherals on that platform. the usual convention is to use #define OMAP_SOMETHING_BASE to allow re-use.
+include/asm-arm/arch-omap/silicon.h contains includes for omapX-silicon.h which defines the base addresses for the peripherals on that platform. the usual convention is to use
+@code
+#define OMAP_SOMETHING_BASE
+@endcode
+to allow re-use.
@section board_omap arch/arm/boards/omap directory guidelines
All Board specific files go here. In u-boot, we always had to use common config file which is shared by other drivers to get serial, ethernet baseaddress etc.. we can easily use the device_d structure to handle it with @a barebox. This is more like programming for Linux kernel - it is pretty easy.
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 15/32] doc: avoid that doxygen parses magic in command.h
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (13 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 14/32] doc: mark code explicitely Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 16/32] doc: fix wrongly named parameter Robert Schwebel
` (16 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Don't let doxygen parse the command magic, which leads to these warnings:
command.h:93: Warning: explicit link request to 'define' could not be resolved
command.h:98: Warning: expected <tr> tag but found TK_LNKWORD token instead!
command.h:98: Warning: Found unknown command `\t'
command.h:101: Warning: explicit link request to 'define' could not be resolved
command.h:103: Warning: explicit link request to 'define' could not be resolved
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
include/command.h | 4 ++++
1 files changed, 4 insertions(+), 0 deletions(-)
diff --git a/include/command.h b/include/command.h
index e235f63..0be7a69 100644
--- a/include/command.h
+++ b/include/command.h
@@ -76,6 +76,8 @@ void barebox_cmd_usage(struct command *cmdtp);
#endif /* __ASSEMBLY__ */
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+
#define Struct_Section __attribute__ ((unused,section (".barebox_cmd")))
#define BAREBOX_CMD_START(_name) \
@@ -93,6 +95,8 @@ const struct command __barebox_cmd_##_name \
#define BAREBOX_CMD_HELP(text)
#endif
+#endif /* DOXYGEN_SHOULD_SKIP_THIS */
+
int register_command(struct command *);
#endif /* __COMMAND_H */
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 16/32] doc: fix wrongly named parameter
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (14 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 15/32] doc: avoid that doxygen parses magic in command.h Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 17/32] doc: fix parameter name in mci-core Robert Schwebel
` (15 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Silence this warning:
lib/parameter.c:85: Warning: argument `value' of command @param is not found in the argument list of dev_set_param(struct device_d *dev, const char *name, const char *val)
lib/parameter.c:85: Warning: The following parameters of dev_set_param(struct device_d *dev, const char *name, const char *val) are not documented:
parameter val
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
lib/parameter.c | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/lib/parameter.c b/lib/parameter.c
index 0aa4193..379a057 100644
--- a/lib/parameter.c
+++ b/lib/parameter.c
@@ -86,7 +86,7 @@ int dev_set_param_ip(struct device_d *dev, char *name, IPaddr_t ip)
* dev_set_param - set a parameter of a device to a new value
* @param dev The device
* @param name The name of the parameter
- * @param value The new value of the parameter
+ * @param val The new value of the parameter
*/
int dev_set_param(struct device_d *dev, const char *name, const char *val)
{
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 17/32] doc: fix parameter name in mci-core
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (15 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 16/32] doc: fix wrongly named parameter Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 18/32] doc: silence doxygen warnings Robert Schwebel
` (14 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Silence this warning:
drivers/mci/mci-core.c:1324: Warning: argument `pdata' of command @param is not found in the argument list of mci_register(struct mci_host *host)
drivers/mci/mci-core.c:1324: Warning: The following parameters of mci_register(struct mci_host *host) are not documented:
parameter host
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
drivers/mci/mci-core.c | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/drivers/mci/mci-core.c b/drivers/mci/mci-core.c
index c92d5a9..097bfa5 100644
--- a/drivers/mci/mci-core.c
+++ b/drivers/mci/mci-core.c
@@ -1323,7 +1323,7 @@ device_initcall(mci_init);
/**
* Create a new mci device (for convenience)
- * @param pdata MCI device's platform data for this MCI device
+ * @param host mci_host for this MCI device
* @return 0 on success
*/
int mci_register(struct mci_host *host)
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 18/32] doc: silence doxygen warnings
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (16 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 17/32] doc: fix parameter name in mci-core Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 18:50 ` Sascha Hauer
2010-10-22 16:45 ` [PATCH 19/32] doc: add macros to unify command help with doxygen Robert Schwebel
` (13 subsequent siblings)
31 siblings, 1 reply; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Silence these warnings:
common/kallsyms.c:8: Warning: documented function `const u8 kallsyms_names' was not declared or defined.
common/kallsyms.c:10: Warning: documented function `const u8 kallsyms_token_table' was not declared or defined.
common/kallsyms.c:11: Warning: documented function `const u16 kallsyms_token_index' was not declared or defined.
common/kallsyms.c:13: Warning: documented function `const unsigned long kallsyms_markers' was not declared or defined.
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
common/kallsyms.c | 4 ++++
1 files changed, 4 insertions(+), 0 deletions(-)
diff --git a/common/kallsyms.c b/common/kallsyms.c
index 4069f4b..490adb9 100644
--- a/common/kallsyms.c
+++ b/common/kallsyms.c
@@ -2,6 +2,8 @@
#include <init.h>
#include <kallsyms.h>
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+
/* These will be re-linked against their real values during the second link stage */
extern const unsigned long kallsyms_addresses[] __attribute__((weak));
extern const unsigned long kallsyms_num_syms __attribute__((weak));
@@ -12,6 +14,8 @@ extern const u16 kallsyms_token_index[] __attribute__((weak));
extern const unsigned long kallsyms_markers[] __attribute__((weak));
+#endif /* DOXYGEN_SHOULD_SKIP_THIS */
+
/* expand a compressed symbol data into the resulting uncompressed string,
given the offset to where the symbol is in the compressed stream */
static unsigned int kallsyms_expand_symbol(unsigned int off, char *result)
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 19/32] doc: add macros to unify command help with doxygen
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (17 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 18/32] doc: silence doxygen warnings Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 20/32] doc: add documentation for 'bmp' Robert Schwebel
` (12 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
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>
---
Doxyfile | 2 +-
include/command.h | 9 ++++
scripts/doxy_filter.awk | 101 +++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 111 insertions(+), 1 deletions(-)
create mode 100644 scripts/doxy_filter.awk
diff --git a/Doxyfile b/Doxyfile
index 912abc1..23f3e43 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -575,7 +575,7 @@ IMAGE_PATH =
# to standard output. If FILTER_PATTERNS is specified, this tag will be
# ignored.
-INPUT_FILTER =
+INPUT_FILTER = "awk -f scripts/doxy_filter.awk"
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
diff --git a/include/command.h b/include/command.h
index 0be7a69..e221546 100644
--- a/include/command.h
+++ b/include/command.h
@@ -89,6 +89,15 @@ const struct command __barebox_cmd_##_name \
#define BAREBOX_CMD_END \
};
+#define BAREBOX_CMD_HELP_START(_name) \
+static const __maybe_unused char cmd_##_name##_help[] =
+
+#define BAREBOX_CMD_HELP_USAGE(_name) "Usage: " _name
+#define BAREBOX_CMD_HELP_SHORT(_text) _text
+#define BAREBOX_CMD_HELP_OPT(_opt, _desc) _opt "\t" _desc
+#define BAREBOX_CMD_HELP_TEXT(_text)
+#define BAREBOX_CMD_HELP_END ;
+
#ifdef CONFIG_LONGHELP
#define BAREBOX_CMD_HELP(text) .help = text,
#else
diff --git a/scripts/doxy_filter.awk b/scripts/doxy_filter.awk
new file mode 100644
index 0000000..0f6e891
--- /dev/null
+++ b/scripts/doxy_filter.awk
@@ -0,0 +1,101 @@
+#!/usr/bin/awk
+
+/BAREBOX_CMD_HELP_START[[:space:]]*\((.*)\)/ {
+
+ this_opt = 0;
+ my_usage = "";
+ my_short = "";
+ my_cmd = gensub("BAREBOX_CMD_HELP_START[[:space:]]*\\((.*)\\)", "\\1", "g");
+ this_text = 0;
+ delete(my_text);
+ delete(my_opts);
+ next;
+}
+
+/BAREBOX_CMD_HELP_USAGE[[:space:]]*\((.*)\)/ {
+
+ $0 = gensub("<", "\\<", "g");
+ $0 = gensub(">", "\\>", "g");
+ $0 = gensub("BAREBOX_CMD_HELP_USAGE[[:space:]]*\\((.*)\\)", "\\1", "g");
+ $0 = gensub("\\\\n", "", "g");
+ my_usage = gensub("\"", "", "g");
+ next;
+
+}
+
+/BAREBOX_CMD_HELP_SHORT[[:space:]]*\((.*)\)/ {
+
+ $0 = gensub("<", "\\<", "g");
+ $0 = gensub(">", "\\>", "g");
+ $0 = gensub("BAREBOX_CMD_HELP_SHORT[[:space:]]*\\((.*)\\)", "\\1", "g");
+ $0 = gensub("\\\\n", "", "g");
+ my_short = gensub("\"", "", "g");
+ next;
+
+}
+
+/BAREBOX_CMD_HELP_OPT[[:space:]]*\([[:space:]]*(.*)[[:space:]]*,[[:space:]]*(.*)[[:space:]]*\)/ {
+
+ $0 = gensub("<", "\\<", "g");
+ $0 = gensub(">", "\\>", "g");
+ $0 = gensub("BAREBOX_CMD_HELP_OPT[[:space:]]*\\([[:space:]]*\"*(.*)\"[[:space:]]*,[[:space:]]*\"(.*)\"[[:space:]]*\\)", \
+ "<tr><td><tt> \\1 </tt></td><td>\\ \\ \\ </td><td> \\2 </td></tr>", "g");
+ $0 = gensub("\\\\n", "", "g");
+ my_opts[this_opt] = gensub("\"", "", "g");
+ this_opt ++;
+ next;
+}
+
+/BAREBOX_CMD_HELP_TEXT[[:space:]]*\((.*)\)/ {
+
+ $0 = gensub("<", "\\<", "g");
+ $0 = gensub(">", "\\>", "g");
+ $0 = gensub("BAREBOX_CMD_HELP_TEXT[[:space:]]*\\((.*)\\)", "\\1", "g");
+ $0 = gensub("\\\\n", "<br>", "g");
+ my_text[this_text] = gensub("\"", "", "g");
+ this_text ++;
+ next;
+}
+
+/BAREBOX_CMD_HELP_END/ {
+
+ printf "/**\n";
+ printf " * @page " my_cmd "_command " my_cmd "\n";
+ printf " *\n";
+ printf " * \\par Usage:\n";
+ printf " * " my_usage "\n";
+ printf " *\n";
+
+ if (this_opt != 0) {
+ printf " * \\par Options:\n";
+ printf " *\n";
+ printf " * <table border=\"0\" cellpadding=\"0\">\n";
+ n = asorti(my_opts, my_opts_sorted);
+ for (i=1; i<=n; i++) {
+ printf " * " my_opts[my_opts_sorted[i]] "\n";
+ }
+ printf " * </table>\n";
+ printf " *\n";
+ }
+
+ printf " * " my_short "\n";
+ printf " *\n";
+
+ n = asorti(my_text, my_text_sorted);
+ if (n > 0) {
+ for (i=1; i<=n; i++) {
+ printf " * " my_text[my_text_sorted[i]] "\n";
+ }
+ printf " *\n";
+ }
+
+ printf " */\n";
+ next;
+}
+
+/^.*$/ {
+
+ print $0;
+
+}
+
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 20/32] doc: add documentation for 'bmp'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (18 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 19/32] doc: add macros to unify command help with doxygen Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 21/32] doc: add documentation for 'clear' Robert Schwebel
` (11 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Documentation/commands.dox | 1 +
commands/bmp.c | 16 ++++++++--------
2 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 5404483..da95e85 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -2,6 +2,7 @@
* @page command_reference Supported Shell Commands
@li @subpage addpart_command
+@li @subpage bmp_command
@li @subpage cat_command
@li @subpage cd_command
@li @subpage cp_command
diff --git a/commands/bmp.c b/commands/bmp.c
index 6e17200..242965a 100644
--- a/commands/bmp.c
+++ b/commands/bmp.c
@@ -193,17 +193,17 @@ failed_memmap:
return 1;
}
-static const __maybe_unused char cmd_bmp_help[] =
-"Usage: bmp [OPTION]... FILE\n"
-"show bmp image FILE.\n"
-" -f <fb> framebuffer device (/dev/fb0)\n"
-" -x <xofs> x offset (default center)\n"
-" -y <yofs> y offset (default center)\n"
-" -o render offscreen\n";
+BAREBOX_CMD_HELP_START(bmp)
+BAREBOX_CMD_HELP_USAGE("bmp [OPTIONS] FILE")
+BAREBOX_CMD_HELP_SHORT("Show the bitmap FILE on the framebuffer.")
+BAREBOX_CMD_HELP_OPT ("-f <fb>", "framebuffer device (/dev/fb0)")
+BAREBOX_CMD_HELP_OPT ("-x <xofs>", "x offset (default center)")
+BAREBOX_CMD_HELP_OPT ("-y <yofs>", "y offset (default center)")
+BAREBOX_CMD_HELP_OPT ("-o", "render offscreen")
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(bmp)
.cmd = do_bmp,
.usage = "show a bmp image",
BAREBOX_CMD_HELP(cmd_bmp_help)
BAREBOX_CMD_END
-
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 21/32] doc: add documentation for 'clear'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (19 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 20/32] doc: add documentation for 'bmp' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 22/32] doc: add documentation for 'crc32' Robert Schwebel
` (10 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Documentation/commands.dox | 1 +
commands/clear.c | 5 +++++
2 files changed, 6 insertions(+), 0 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index da95e85..f829a3c 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -5,6 +5,7 @@
@li @subpage bmp_command
@li @subpage cat_command
@li @subpage cd_command
+@li @subpage clear_command
@li @subpage cp_command
@li @subpage delpart_command
@li @subpage devinfo_command
diff --git a/commands/clear.c b/commands/clear.c
index 7589a0c..6a6b6c5 100644
--- a/commands/clear.c
+++ b/commands/clear.c
@@ -31,6 +31,11 @@ static int do_clear(struct command *cmdtp, int argc, char *argv[])
return 0;
}
+BAREBOX_CMD_HELP_START(clear)
+BAREBOX_CMD_HELP_USAGE("clear\n")
+BAREBOX_CMD_HELP_SHORT("Clear the screen.\n")
+BAREBOX_CMD_HELP_END
+
BAREBOX_CMD_START(clear)
.cmd = do_clear,
.usage = "clear screen",
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 22/32] doc: add documentation for 'crc32'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (20 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 21/32] doc: add documentation for 'clear' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 23/32] doc: add documentation for 'dfu' Robert Schwebel
` (9 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Documentation/commands.dox | 1 +
commands/crc.c | 15 +++++++--------
2 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index f829a3c..cfff884 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -7,6 +7,7 @@
@li @subpage cd_command
@li @subpage clear_command
@li @subpage cp_command
+@li @subpage crc_command
@li @subpage delpart_command
@li @subpage devinfo_command
@li @subpage edit_command
diff --git a/commands/crc.c b/commands/crc.c
index d3e0865..0873a1c 100644
--- a/commands/crc.c
+++ b/commands/crc.c
@@ -143,19 +143,18 @@ static int do_crc(struct command *cmdtp, int argc, char *argv[])
return err;
}
-static const __maybe_unused char cmd_crc_help[] =
-"Usage: crc32 [OPTION] [AREA]\n"
-"Calculate a crc32 checksum of a memory area\n"
-"Options:\n"
-" -f <file> Use file instead of memory\n"
+BAREBOX_CMD_HELP_START(crc)
+BAREBOX_CMD_HELP_USAGE("crc32 [OPTION] [AREA]\n")
+BAREBOX_CMD_HELP_SHORT("Calculate a crc32 checksum of a memory area.\n")
+BAREBOX_CMD_HELP_OPT ("-f <file>", "Use file instead of memory.\n")
#ifdef CONFIG_CMD_CRC_CMP
-" -F <file> Use file to compare\n"
+BAREBOX_CMD_HELP_OPT ("-F <file>", "Use file to compare.\n")
#endif
-" -v <crc> Verfify\n";
+BAREBOX_CMD_HELP_OPT ("-v <crc>", "Verfify\n")
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(crc32)
.cmd = do_crc,
.usage = "crc32 checksum calculation",
BAREBOX_CMD_HELP(cmd_crc_help)
BAREBOX_CMD_END
-
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 23/32] doc: add documentation for 'dfu'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (21 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 22/32] doc: add documentation for 'crc32' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 24/32] doc: unify documentation for 'ls' Robert Schwebel
` (8 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Documentation/commands.dox | 1 +
commands/dfu.c | 21 +++++++++++----------
2 files changed, 12 insertions(+), 10 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index cfff884..f3b5028 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -10,6 +10,7 @@
@li @subpage crc_command
@li @subpage delpart_command
@li @subpage devinfo_command
+@li @subpage dfu_command
@li @subpage edit_command
@li @subpage erase_command
@li @subpage export_command
diff --git a/commands/dfu.c b/commands/dfu.c
index 66fd6ea..6750130 100644
--- a/commands/dfu.c
+++ b/commands/dfu.c
@@ -162,16 +162,17 @@ out:
return 1;
}
-static const __maybe_unused char cmd_dfu_help[] =
-"Usage: dfu [OPTION]... description\n"
-"start dfu firmware update\n"
-" -m <str> Manufacturer string (barebox)\n"
-" -p <str> product string (" CONFIG_BOARDINFO ")\n"
-" -V <id> vendor id\n"
-" -P <id> product id\n"
-"description has the form\n"
-"device1(name1)[sr],device2(name2)[sr]\n"
-"where s is for save mode and r for read back of firmware\n";
+BAREBOX_CMD_HELP_START(dfu)
+BAREBOX_CMD_HELP_USAGE("dfu [OPTIONS] <description>\n")
+BAREBOX_CMD_HELP_SHORT("Start firmware update with the Device Firmware Update (DFU) protocol.")
+BAREBOX_CMD_HELP_OPT ("-m <str>", "Manufacturer string (barebox)\n")
+BAREBOX_CMD_HELP_OPT ("-p <str>", "product string (" CONFIG_BOARDINFO ")\n")
+BAREBOX_CMD_HELP_OPT ("-V <id>", "vendor id\n")
+BAREBOX_CMD_HELP_OPT ("-P <id>", "product id\n")
+BAREBOX_CMD_HELP_TEXT ("<description> has the form:")
+BAREBOX_CMD_HELP_TEXT ("device1(name1)[sr],device2(name2)[sr]")
+BAREBOX_CMD_HELP_TEXT ("where "s" means "safe mode" and "r" readback of firmware.")
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(dfu)
.cmd = do_dfu,
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 24/32] doc: unify documentation for 'ls'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (22 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 23/32] doc: add documentation for 'dfu' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 25/32] doc: unify documentation for 'cat' Robert Schwebel
` (7 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Documentation/commands.dox | 1 +
commands/ls.c | 9 +++++----
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index f3b5028..63ed480 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -16,6 +16,7 @@
@li @subpage export_command
@li @subpage tftp_command
@li @subpage loadenv_command
+@li @subpage ls_command
@li @subpage mount_command
@li @subpage printenv_command
@li @subpage protect_command
diff --git a/commands/ls.c b/commands/ls.c
index a02ccfe..2005178 100644
--- a/commands/ls.c
+++ b/commands/ls.c
@@ -194,10 +194,11 @@ static int do_ls(struct command *cmdtp, int argc, char *argv[])
return 0;
}
-static const __maybe_unused char cmd_ls_help[] =
-"Usage: ls [OPTION]... [FILE]...\n"
-"List information about the FILEs (the current directory by default).\n"
-" -R list subdirectories recursively\n";
+BAREBOX_CMD_HELP_START(ls)
+BAREBOX_CMD_HELP_USAGE("ls [OPTION]... [FILE]...\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
BAREBOX_CMD_START(ls)
.cmd = do_ls,
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 25/32] doc: unify documentation for 'cat'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (23 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 24/32] doc: unify documentation for 'ls' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 26/32] doc: unify documentation for 'cd' Robert Schwebel
` (6 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
commands/cat.c | 19 ++++++-------------
1 files changed, 6 insertions(+), 13 deletions(-)
diff --git a/commands/cat.c b/commands/cat.c
index 41b3324..37e6505 100644
--- a/commands/cat.c
+++ b/commands/cat.c
@@ -85,22 +85,15 @@ out:
return err;
}
-static const __maybe_unused char cmd_cat_help[] =
-"Usage: cat [FILES]\n"
-"Concatenate files on stdout. Currently only printable characters\n"
-"and \\n and \\t are printed, but this should be optional\n";
+BAREBOX_CMD_HELP_START(cat)
+BAREBOX_CMD_HELP_USAGE("cat [FILES]\n")
+BAREBOX_CMD_HELP_SHORT("Concatenate files on stdout.\n")
+BAREBOX_CMD_HELP_TEXT ("Currently only printable characters and \\ n and \\ t are printed,\n")
+BAREBOX_CMD_HELP_TEXT ("but this should be optional.\n")
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(cat)
.cmd = do_cat,
.usage = "concatenate file(s)",
BAREBOX_CMD_HELP(cmd_cat_help)
BAREBOX_CMD_END
-
-/**
- * @page cat_command cat (concatenate)
- *
- * Usage is: cat \<file\> [\<file\> ...]
- *
- * Concatenate files to stdout. Currently only printable characters
- * and \\n and \\t are printed, but this should be optional
- */
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 26/32] doc: unify documentation for 'cd'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (24 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 25/32] doc: unify documentation for 'cat' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 27/32] doc: add documentation for 'echo' Robert Schwebel
` (5 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
commands/cd.c | 17 +++++------------
1 files changed, 5 insertions(+), 12 deletions(-)
diff --git a/commands/cd.c b/commands/cd.c
index a842f4d..d73be32 100644
--- a/commands/cd.c
+++ b/commands/cd.c
@@ -47,21 +47,14 @@ static int do_cd(struct command *cmdtp, int argc, char *argv[])
return 0;
}
-static const __maybe_unused char cmd_cd_help[] =
-"Usage: cd [directory]\n"
-"change to directory. If called without argument, change to /\n";
+BAREBOX_CMD_HELP_START(cd)
+BAREBOX_CMD_HELP_USAGE("cd [directory]\n")
+BAREBOX_CMD_HELP_SHORT("Change to directory.\n")
+BAREBOX_CMD_HELP_TEXT ("If called without an argument, change to the root directory /.\n")
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(cd)
.cmd = do_cd,
.usage = "change working directory",
BAREBOX_CMD_HELP(cmd_cd_help)
BAREBOX_CMD_END
-
-/**
- * @page cd_command cd (change working directory)
- *
- * Usage is: cd [\<directory name>]
- *
- * Change to \<directory name>. If called without argument, change to \b /
- * (root)
- */
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 27/32] doc: add documentation for 'echo'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (25 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 26/32] doc: unify documentation for 'cd' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 28/32] doc: unify documentation for 'edit' Robert Schwebel
` (4 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Documentation/commands.dox | 1 +
commands/echo.c | 10 ++++++++++
2 files changed, 11 insertions(+), 0 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 63ed480..28ddff4 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -11,6 +11,7 @@
@li @subpage delpart_command
@li @subpage devinfo_command
@li @subpage dfu_command
+@li @subpage echo_command
@li @subpage edit_command
@li @subpage erase_command
@li @subpage export_command
diff --git a/commands/echo.c b/commands/echo.c
index dfa14d6..5cc150d 100644
--- a/commands/echo.c
+++ b/commands/echo.c
@@ -111,8 +111,18 @@ no_optarg_out:
return 1;
}
+BAREBOX_CMD_HELP_START(echo)
+BAREBOX_CMD_HELP_USAGE("echo [OPTION]... [STRING]\n")
+BAREBOX_CMD_HELP_SHORT("Display a line of text.\n")
+BAREBOX_CMD_HELP_OPT ("-n", "do not output the trailing newline\n")
+BAREBOX_CMD_HELP_OPT ("-a", "FIXME\n")
+BAREBOX_CMD_HELP_OPT ("-o", "FIXME\n")
+BAREBOX_CMD_HELP_OPT ("-e", "FIXME\n")
+BAREBOX_CMD_HELP_END
+
BAREBOX_CMD_START(echo)
.cmd = do_echo,
.usage = "echo args to console",
+ BAREBOX_CMD_HELP(cmd_echo_help)
BAREBOX_CMD_END
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 28/32] doc: unify documentation for 'edit'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (26 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 27/32] doc: add documentation for 'echo' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 29/32] doc: add documentation for 'bootm' Robert Schwebel
` (3 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
commands/edit.c | 36 +++++++++++-------------------------
1 files changed, 11 insertions(+), 25 deletions(-)
diff --git a/commands/edit.c b/commands/edit.c
index c2ab877..d35097e 100644
--- a/commands/edit.c
+++ b/commands/edit.c
@@ -550,35 +550,21 @@ out:
static const char *edit_aliases[] = { "sedit", NULL};
-static const __maybe_unused char cmd_edit_help[] =
-"Usage: (s)edit <file>\n"
-"This is a very small editor. Its only features are moving the cursor with\n"
-"the usual keys and typing characters.\n"
-"<ctrl-c> quits the editor without saving,\n"
-"<ctrl-d> quits the editor with saving the current file.\n"
-"\n"
-"If called as sedit the editor uses ansi codes to scroll the screen.\n";
-
-static const __maybe_unused char cmd_edit_usage[] = "edit a file";
+BAREBOX_CMD_HELP_START(edit)
+BAREBOX_CMD_HELP_USAGE("(s)edit <file>\n")
+BAREBOX_CMD_HELP_SHORT("A small editor. <ctrl-c> is exit, <ctrl-d> exit-with-save.\n")
+BAREBOX_CMD_HELP_TEXT ("This is a very small text editor. You can move the cursor around\n")
+BAREBOX_CMD_HELP_TEXT ("with the usual keys and type characters.\n")
+BAREBOX_CMD_HELP_TEXT ("<ctrl-c> quits the editor without saving,\n")
+BAREBOX_CMD_HELP_TEXT ("<ctrl-d> quits the editor with saving the current file.\n")
+BAREBOX_CMD_HELP_TEXT (" \n")
+BAREBOX_CMD_HELP_TEXT ("If called as sedit, the editor uses ansi codes to scroll the screen.\n")
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(edit)
.cmd = do_edit,
.aliases = edit_aliases,
- .usage = cmd_edit_usage,
+ .usage = "Usage: (s)edit <file>",
BAREBOX_CMD_HELP(cmd_edit_help)
BAREBOX_CMD_END
-
-/**
- * @page edit_command edit (editor)
- *
- * Usage is: [s]edit \<file\>
- *
- * This is a very small editor. It's only features are moving the cursor with
- * the usual keys and typing characters.
- *
- * \b \<ctrl-c\> quits the editor without saving,\n
- * \b \<ctrl-d\> quits the editor with saving the current file.
- *
- * If called as \c sedit the editor uses ansi codes to scroll the screen.
- */
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 29/32] doc: add documentation for 'bootm'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (27 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 28/32] doc: unify documentation for 'edit' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 30/32] doc: unify documentation for 'addpart' Robert Schwebel
` (2 subsequent siblings)
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
Documentation/commands.dox | 1 +
commands/bootm.c | 18 ++++++------------
2 files changed, 7 insertions(+), 12 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 28ddff4..c1471fb 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -3,6 +3,7 @@
@li @subpage addpart_command
@li @subpage bmp_command
+@li @subpage bootm_command
@li @subpage cat_command
@li @subpage cd_command
@li @subpage clear_command
diff --git a/commands/bootm.c b/commands/bootm.c
index 0d3649f..5cf97e8 100644
--- a/commands/bootm.c
+++ b/commands/bootm.c
@@ -368,18 +368,12 @@ err_out:
return 1;
}
-static const __maybe_unused char cmd_bootm_help[] =
-"Usage: bootm [OPTION] image\n"
-"Boot application image\n"
-" -n do not verify the images (speeds up boot process)\n"
-" -h show advanced options\n";
-
-
-BAREBOX_CMD_START(bootm)
- .cmd = do_bootm,
- .usage = "boot application image",
- BAREBOX_CMD_HELP(cmd_bootm_help)
-BAREBOX_CMD_END
+BAREBOX_CMD_HELP_START(bootm)
+BAREBOX_CMD_HELP_USAGE("bootm [OPTION] image\n")
+BAREBOX_CMD_HELP_SHORT("Boot an application image.\n")
+BAREBOX_CMD_HELP_OPT ("-n", "do not verify the images (speeds up boot process)")
+BAREBOX_CMD_HELP_END
+
#ifdef CONFIG_CMD_IMI
static int do_iminfo(struct command *cmdtp, int argc, char *argv[])
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 30/32] doc: unify documentation for 'addpart'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (28 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 29/32] doc: add documentation for 'bootm' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 31/32] doc: unify documentation for 'cp' Robert Schwebel
2010-10-22 16:45 ` [PATCH 32/32] doc: unify documentation for 'delpart' Robert Schwebel
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
commands/partition.c | 45 ++++++++++++---------------------------------
1 files changed, 12 insertions(+), 33 deletions(-)
diff --git a/commands/partition.c b/commands/partition.c
index a1edcf6..89fb519 100644
--- a/commands/partition.c
+++ b/commands/partition.c
@@ -149,19 +149,18 @@ static int do_addpart(struct command * cmdtp, int argc, char *argv[])
return 0;
}
-static const __maybe_unused char cmd_addpart_help[] =
-"Usage: addpart <device> <partition description>\n"
-"\n"
-"addpart adds a partition description to a device. The partition description\n"
-"has the form\n"
-"size1[@offset1](name1)[ro],size2[@offset2](name2)[ro],...\n"
-"<device> is the device name under. Size and offset can be given in decimal\n"
-"or - if prefixed with 0x in hex. Both can have an optional suffix K,M,G.\n"
-"The size of the last partition can be specified as '-' for the remaining\n"
-"space of the device.\n"
-"This format is the same as used in the Linux kernel for cmdline mtd partitions.\n"
-"\n"
-"Note: That this command has to be reworked and will probably change it's API.";
+BAREBOX_CMD_HELP_START(addpart)
+BAREBOX_CMD_HELP_USAGE("addpart <device> <part_desc>\n")
+BAREBOX_CMD_HELP_SHORT("Add a partition description to a device.\n")
+BAREBOX_CMD_HELP_OPT ("<device>", "device being worked on\n")
+BAREBOX_CMD_HELP_OPT ("<part_desc>", "size1[@offset1](name1)[ro],size2[@offset2](name2)[ro],...\n")
+BAREBOX_CMD_HELP_TEXT ("Size and offset can be given in decimal hex (prefixed with 0x).\n")
+BAREBOX_CMD_HELP_TEXT ("Both can have an optional suffix K, M or G. The size of the last partition\n")
+BAREBOX_CMD_HELP_TEXT ("can be specified as '-' for the remaining space on the device. This format\n")
+BAREBOX_CMD_HELP_TEXT ("is the same as used by the Linux kernel or cmdline mtd partitions.\n")
+BAREBOX_CMD_HELP_TEXT ("\n")
+BAREBOX_CMD_HELP_TEXT ("@note This command has to be reworked and will probably change it's API.\n")
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(addpart)
.cmd = do_addpart,
@@ -169,26 +168,6 @@ BAREBOX_CMD_START(addpart)
BAREBOX_CMD_HELP(cmd_addpart_help)
BAREBOX_CMD_END
-/** @page addpart_command addpart Add a partition to a device
- *
- * Usage is: addpart \<device> \<partition description>
- *
- * Adds a partition description to a device. The partition description has the
- * form
- *
- * size1[\@offset1](name1)[ro],size2[\@offset2](name2)[ro],...
- *
- * \<device> is the device name under. Size and offset can be given in decimal
- * or - if prefixed with 0x - in hex. Both can have an optional suffix K,M,G.
- * The size of the last partition can be specified as '-' for the remaining
- * space of the device.
- *
- * @note The format is the same as used in the Linux kernel for cmdline mtd
- * partitions.
- *
- * @note This command has to be reworked and will probably change it's API.
- */
-
static int do_delpart(struct command * cmdtp, int argc, char *argv[])
{
int i, err;
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 31/32] doc: unify documentation for 'cp'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (29 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 30/32] doc: unify documentation for 'addpart' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
2010-10-22 16:45 ` [PATCH 32/32] doc: unify documentation for 'delpart' Robert Schwebel
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
commands/cp.c | 24 ++++++++----------------
1 files changed, 8 insertions(+), 16 deletions(-)
diff --git a/commands/cp.c b/commands/cp.c
index 2c35ba1..a99c9b5 100644
--- a/commands/cp.c
+++ b/commands/cp.c
@@ -51,7 +51,7 @@ static int do_cp(struct command *cmdtp, int argc, char *argv[])
if (S_ISDIR(statbuf.st_mode))
last_is_dir = 1;
}
-
+
if (argc > 3 && !last_is_dir) {
printf("cp: target `%s' is not a directory\n", argv[argc - 1]);
return 1;
@@ -77,10 +77,13 @@ out:
return ret;
}
-static const __maybe_unused char cmd_cp_help[] =
-"Usage: cp <source> <destination>\n"
-"cp copies file <source> to <destination>.\n"
-"This command is file based only. See memcpy for memory copy\n";
+BAREBOX_CMD_HELP_START(cp)
+BAREBOX_CMD_HELP_USAGE("cp <source> <destination>\n")
+BAREBOX_CMD_HELP_SHORT("cp copies file <source> to <destination>.\n")
+BAREBOX_CMD_HELP_TEXT ("This command is file based. If you want to copy between memory blocks,\n")
+BAREBOX_CMD_HELP_TEXT ("use 'memcpy'.\n")
+
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(cp)
.cmd = do_cp,
@@ -88,14 +91,3 @@ BAREBOX_CMD_START(cp)
BAREBOX_CMD_HELP(cmd_cp_help)
BAREBOX_CMD_END
-/**
- * @page cp_command cp: Copy file
- *
- * Usage: cp \<source> [\<source>] \<destination>
- *
- * \c cp copies file \<source> to \<destination>
- *
- * Currently only this form is supported and you have to specify the exact
- * target filename (not a target directory).\n
- * This command is file based only. See memcpy for generic memory copy
- */
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread* [PATCH 32/32] doc: unify documentation for 'delpart'
2010-10-22 16:44 Documentation Updates Robert Schwebel
` (30 preceding siblings ...)
2010-10-22 16:45 ` [PATCH 31/32] doc: unify documentation for 'cp' Robert Schwebel
@ 2010-10-22 16:45 ` Robert Schwebel
31 siblings, 0 replies; 35+ messages in thread
From: Robert Schwebel @ 2010-10-22 16:45 UTC (permalink / raw)
To: barebox
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
commands/partition.c | 13 ++++---------
1 files changed, 4 insertions(+), 9 deletions(-)
diff --git a/commands/partition.c b/commands/partition.c
index 89fb519..7c7f5ae 100644
--- a/commands/partition.c
+++ b/commands/partition.c
@@ -183,9 +183,10 @@ static int do_delpart(struct command * cmdtp, int argc, char *argv[])
return 1;
}
-static const __maybe_unused char cmd_delpart_help[] =
-"Usage: delpart FILE...\n"
-"Delete partitions previously added to a device with addpart.\n";
+BAREBOX_CMD_HELP_START(delpart)
+BAREBOX_CMD_HELP_USAGE("delpart FILE...\n")
+BAREBOX_CMD_HELP_SHORT("Delete partitions previously added to a device with addpart.\n")
+BAREBOX_CMD_HELP_END
BAREBOX_CMD_START(delpart)
.cmd = do_delpart,
@@ -193,9 +194,3 @@ BAREBOX_CMD_START(delpart)
BAREBOX_CMD_HELP(cmd_delpart_help)
BAREBOX_CMD_END
-/** @page delpart_command delpart Delete a partition
- *
- * Usage is: delpart \<partions>
- *
- * Delete a partition previously added to a device with addpart.
- */
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 35+ messages in thread