diff options
author | Sascha Hauer <s.hauer@pengutronix.de> | 2010-11-17 09:45:23 +0100 |
---|---|---|
committer | Sascha Hauer <s.hauer@pengutronix.de> | 2010-11-17 09:45:23 +0100 |
commit | 4d63d07ffa3a6065ad67ba03209b4dbe8a0e6f94 (patch) | |
tree | 2b937c2331f16c13321d0c6e73a112cea739a64d | |
parent | 8ef2947fff0e73f38fccd4a65da250f4cb6c1007 (diff) | |
parent | 4ce5028ecd5992e492b8f7bbfb20bf3eddb7d414 (diff) | |
download | barebox-4d63d07ffa3a6065ad67ba03209b4dbe8a0e6f94.tar.gz barebox-4d63d07ffa3a6065ad67ba03209b4dbe8a0e6f94.tar.xz |
Merge branch 'for-mainline-doc' of git://git.pengutronix.de/git/rsc/barebox into next
-rw-r--r-- | .gitignore | 3 | ||||
-rw-r--r-- | Documentation/commands.dox | 67 | ||||
-rw-r--r-- | Doxyfile | 2 | ||||
-rw-r--r-- | Makefile | 7 |
4 files changed, 74 insertions, 5 deletions
diff --git a/.gitignore b/.gitignore index 2c580c6b1f..4a4511394c 100644 --- a/.gitignore +++ b/.gitignore @@ -48,6 +48,9 @@ include/config include/linux/compile.h include/generated +# Generated files +Doxyfile.version + # stgit generated dirs patches-* diff --git a/Documentation/commands.dox b/Documentation/commands.dox index 27eb511679..5ef7829aa8 100644 --- a/Documentation/commands.dox +++ b/Documentation/commands.dox @@ -15,34 +15,97 @@ available in @a Barebox: \todo Sort this by functionality? +@li @subpage _name @li @subpage addpart_command +@li @subpage alternate @li @subpage bmp_command @li @subpage bootm_command +@li @subpage bootu +@li @subpage bootz @li @subpage cat_command @li @subpage cd_command @li @subpage clear_command +@li @subpage clko @li @subpage cp_command +@li @subpage cpufreq +@li @subpage cpuinfo @li @subpage crc_command +@li @subpage crc32 @li @subpage delpart_command @li @subpage devinfo_command @li @subpage dfu_command +@li @subpage dhcp +@li @subpage dump_clocks @li @subpage echo_command @li @subpage edit_command @li @subpage erase_command +@li @subpage ethact +@li @subpage exec +@li @subpage exit @li @subpage export_command +@li @subpage false +@li @subpage getopt @li @subpage gpio_get_value_command @li @subpage gpio_set_value_command @li @subpage gpio_direction_input_command @li @subpage gpio_direction_output_command -@li @subpage tftp_command +@li @subpage go +@li @subpage help +@li @subpage host +@li @subpage i2c_probe +@li @subpage i2c_read +@li @subpage i2c_write +@li @subpage icache +@li @subpage iminfo +@li @subpage insmod +@li @subpage linux16_command @li @subpage loadenv_command +@li @subpage loadb +@li @subpage loady +@li @subpage loadxc +@li @subpage login @li @subpage ls_command +@li @subpage lsmod +@li @subpage md +@li @subpage memcmp +@li @subpage meminfo +@li @subpage memset +@li @subpage menu +@li @subpage mkdir @li @subpage mount_command +@li @subpage mtest +@li @subpage mw +@li @subpage mycdev +@li @subpage nand +@li @subpage nand_boot_test +@li @subpage nfs +@li @subpage passwd +@li @subpage ping @li @subpage printenv_command @li @subpage protect_command +@li @subpage pwd +@li @subpage readline +@li @subpage reset +@li @subpage rarpboot +@li @subpage reginfo +@li @subpage rm +@li @subpage rmdir @li @subpage saveenv_command @li @subpage setenv_command +@li @subpage sh +@li @subpage sleep +@li @subpage source +@li @subpage test +@li @subpage timeout +@li @subpage true +@li @subpage tftp_command +@li @subpage ubiattach +@li @subpage ubimkvol +@li @subpage ubirmvol +@li @subpage umount +@li @subpage unlzo @li @subpage unprotect_command -@li @subpage linux16_command +@li @subpage usb +@li @subpage version */ @@ -31,7 +31,7 @@ PROJECT_NAME = barebox # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 1 +@INCLUDE = Doxyfile.version # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. @@ -762,6 +762,9 @@ include/config/kernel.release: include/config/auto.conf FORCE $(Q)rm -f $@ $(Q)echo $(kernelrelease) > $@ +Doxyfile.version: include/config/auto.conf FORCE + $(Q)rm -f $@ + $(Q)echo "PROJECT_NUMBER = $(KERNELRELEASE)" > $@ # Things we need to do before we recursively start building the kernel # or the modules are listed in "prepare". @@ -973,7 +976,7 @@ endif # CONFIG_MODULES CLEAN_DIRS += $(MODVERDIR) CLEAN_FILES += barebox System.map include/generated/barebox_default_env.h \ .tmp_version .tmp_barebox* barebox.bin barebox.S \ - .tmp_kallsyms* barebox_default_env barebox.ldr + .tmp_kallsyms* barebox_default_env barebox.ldr Doxyfile.version # Directories & files removed with 'make mrproper' MRPROPER_DIRS += include/config include2 usr/include @@ -1098,7 +1101,7 @@ help: docs : htmldocs -htmldocs: +htmldocs: Doxyfile.version @echo 'Running doxygen with local Doxyfile' $(Q)doxygen Doxyfile |