Mirrors/u-boot
2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2024-11-26 22:52:18 +00:00
Code Issues Projects Releases Packages Wiki Activity
u-boot/doc
History
Marek Vasut 30ff89189b kerneldoc: Implant DocBook from Linux kernel 
Pull slightly modified version of Documentation/DocBook, the related perl
script scripts/kernel-doc and the scripts/docproc.c from Linux kernel and
implant it into U-Boot. This will allow smooth generation of kerneldoc
style documentation.

It was necessary to modify the DocBook/Makefile to work with U-Boot build
system. The changes were only minor though and involved replacing the kbuild
specific parts.

It was also necessary to replace use of variables like KERNEL_VERSION with
U_BOOT_VERSION, strings like Linux kernel with U-Boot Bootloader etc. so
the generated result actually matches.

Finally, it was necessary to adjust docproc.c, since the documentation in
U-Boot is located in doc/DocBook instead of Documentation/DocBook as is in
case of the Linux kernel.

Some parts of the DocBook Makefile are unused, but to allow easier sync with
Linux kernel, these parts are still left in. The targets enabled now are
"htmldocs" "pdfdocs" "psdocs" "xmldocs" and "cleandocs" to remove the results
of documentation build.

Linux scripts/docproc.c:
commit f0f3ca8d967462dafb815412b14ca3339b9817a6
Date:   Wed Jun 15 11:53:13 2011 +0200

Linux scripts/kernel-doc:
commit 1b40c1944db445c1de1c47ffd8cd426167f488e8
Date:   Sun Aug 12 10:46:15 2012 +0200

Linux Documentation/DocBook:
commit bb8187d35f820671d6dd76700d77a6b55f95e2c5
Date:   Thu May 17 19:06:13 2012 -0400

Signed-off-by: Marek Vasut <marex@denx.de>
2012-10-15 11:54:14 -07:00
..
device-tree-bindings tegra: fdt: Add NAND controller binding and definitions 2012-09-07 13:54:30 -07:00
DocBook kerneldoc: Implant DocBook from Linux kernel 2012-10-15 11:54:14 -07:00
driver-model dm: Add twserial device document 2012-09-02 18:00:02 +02:00
SPL README.SPL: Move the 'Estimating stack usage' from omap3 to here 2012-09-02 19:39:46 +02:00
uImage.FIT net ppc: fix ethernet device names with spaces 2010-08-09 11:52:28 -07:00
feature-removal-schedule.txt miiphy: Note that miiphy_* API is deprecated 2011-12-05 22:17:06 +01:00
git-mailrc doc/git-mailrc: Add 'rmobile' alias 2012-10-03 02:04:26 +02:00
I2C_Edge_Conditions rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
kwboot.1 kwboot: boot kirkwood SoCs over a serial link 2012-07-07 14:07:32 +02:00
mkimage.1 doc/mkimage.1: Fix -D/-f options formatting 2011-12-23 20:11:46 +01:00
README.440-DDR-performance PPC440 DDR setup: Set SDRAM0_CFG0[PMU]=0 for best performance 2006-07-28 18:34:58 +02:00
README.ag102 board/adp-ag102: add configuration of adp-ag102 2012-04-22 16:58:23 +08:00
README.AMCC-eval-boards-cleanup Major cleanup for AMCC PPC4xx eval boards. 2005-08-01 16:49:12 +02:00
README.arm-caches cache: add ALLOC_CACHE_ALIGN_BUFFER macro 2011-10-25 09:23:10 +02:00
README.ARM-memory-map Rename TEXT_BASE into CONFIG_SYS_TEXT_BASE 2010-10-18 22:07:10 +02:00
README.arm-relocation Minor coding style cleanup. 2011-05-19 22:22:44 +02:00
README.ARM-SoC arm: Move cpu/$CPU to arch/arm/cpu/$CPU 2010-04-13 09:13:24 +02:00
README.arm-unaligned-accesses ARM: prevent misaligned array inits 2012-10-15 11:53:07 -07:00
README.at91 doc: Fix some typos in different files 2012-03-27 13:31:37 +02:00
README.at91-soc Minor coding style cleanup. 2011-09-11 21:24:09 +02:00
README.atmel_mci ATMEL: remove old atmel_mci driver 2012-03-13 12:06:42 +01:00
README.atmel_pmecc at91: atmel_nand: Update driver to support Programmable Multibit ECC controller 2012-09-01 17:06:14 +02:00
README.autoboot Fix printf() format problems with configurable prompts 2008-07-31 17:08:27 +02:00
README.AVR32 avr32: Update README 2008-09-01 13:41:58 +02:00
README.AVR32-port-muxing doc: Fix some typos in different files 2012-03-27 13:31:37 +02:00
README.bedbug Move arch/ppc to arch/powerpc 2010-04-21 23:42:38 +02:00
README.bitbangMII Coding Style cleanup; update CHANGELOG, prepare -rc1 2009-10-28 00:49:47 +01:00
README.blackfin add some more Blackfin docs 2008-02-04 19:26:54 -05:00
README.bus_vcxk Prepare 2009.08-rc1 2009-07-27 00:24:55 +02:00
README.cfi mpc5200, digsy_mtc: add support for rev5 board version 2011-01-18 23:34:26 +01:00
README.commands README.commands: Document what UNDEF_SYM does 2012-09-26 11:08:32 -07:00
README.commands.itest * Patch by Laurent Mohin, 10 Feb 2004: 2004-02-23 20:48:38 +00:00
README.commands.spl Add cmd_spl command 2012-03-27 22:05:28 +02:00
README.console doc: provide a correct board_init_r definition path 2011-09-23 08:12:28 +02:00
README.davinci arm, da850evm: Add an SPL for SPI boot 2011-12-24 10:23:30 +01:00
README.davinci.nand_spl arm, davinci: add cam_enc_4xx support 2011-11-03 22:56:25 +01:00
README.designware_eth SPEAr : Network driver support added 2010-07-12 00:08:05 -07:00
README.dns Coding Style cleanup; update CHANGELOG. 2009-07-23 22:23:23 +02:00
README.drivers.eth Program net device MAC addresses after initializing 2010-05-03 14:52:49 -07:00
README.enetaddr net: allow setting env enetaddr from net device setting 2012-07-11 13:15:32 -05:00
README.ext4 ext4fs write support 2012-08-09 23:48:02 +02:00
README.fdt-control fdt: ARM: Add fdtcontroladdr to set device tree address in environment 2011-10-26 21:40:16 +02:00
README.fsl-ddr powerpc/mpc8xxx: Enable 3-way and 4-way DDR interleaving 2012-08-23 12:16:55 -05:00
README.fsl-hwconfig powerpc/85xx: Specify hwconfig usage for USB controller 2011-07-11 13:24:20 -05:00
README.generic_usb_ohci rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.hwconfig doc: add README for CONFIG_HWCONFIG option 2010-03-12 00:09:25 +01:00
README.idma2intr * Patch by Arun Dharankar, 4 Apr 2003: 2003-04-05 00:53:31 +00:00
README.imx5 ARM: MX51: PLL errata workaround 2011-09-04 11:36:11 +02:00
README.imx31 move README.imx31 to doc/ and merge with README.mx31 2008-10-08 18:59:04 +02:00
README.imximage imximage: Add support for i.MX6 2012-02-12 10:11:25 +01:00
README.iomux IOMUX: Add console multiplexing support. 2008-12-07 01:23:35 +01:00
README.JFFS2 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.JFFS2_NAND Fix "par[t]ition" typo. 2010-05-21 22:05:05 +02:00
README.kwbimage cosmetic: Better explain how to use the kirkwood kwbimage.cfg file. 2012-09-03 17:44:37 +05:30
README.LED Move lib_$ARCH directories to arch/$ARCH/lib 2010-04-13 09:13:03 +02:00
README.LED_display led_display: remove unused DISPLAY_MARK define 2010-10-21 22:25:04 +02:00
README.link-local Minor Coding Style cleanup 2012-07-10 09:18:33 +02:00
README.lynxkdi rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.m28 mxs: reorganize source directory for easy sharing of code in i.MXS SoCs 2012-09-01 14:58:17 +02:00
README.m68k cleanup: Fix typos and misspellings in various files. 2011-07-28 21:27:36 +02:00
README.marubun-pcmcia rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.menu common, menu: show menu on startup if CONFIG_MENU_SHOW is defined 2012-02-12 10:11:24 +01:00
README.mini2440 ARM : Add support for MINI2440 (s3c2440). 2012-10-03 10:50:27 +02:00
README.mips doc/README.mips: Add MIPS notes 2008-04-25 00:03:53 +02:00
README.Modem * Code cleanup: 2003-06-27 21:31:46 +00:00
README.mpc5xx Move arch/ppc to arch/powerpc 2010-04-21 23:42:38 +02:00
README.mpc74xx Initial revision 2002-11-02 23:30:20 +00:00
README.mpc83xx.ddrecc mpc83xx: Correct the README for DDR ECC 2007-08-10 01:13:11 -05:00
README.mpc83xxads Add support for ep8248 board 2005-08-06 01:42:58 +02:00
README.mpc85xx Minor Coding Style Cleanup. 2012-07-22 21:58:26 +02:00
README.mpc85xxads doc: Fix some typos in different files 2012-03-27 13:31:37 +02:00
README.mpc85xxcds * Patch by Jon Loeliger, 2005-05-05 2005-07-25 14:05:07 -05:00
README.MPC866 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.mx28_common mx28: Fix elftosb source link in README.mx28_common 2012-07-20 23:03:27 +02:00
README.mx28evk mxs: reorganize source directory for easy sharing of code in i.MXS SoCs 2012-09-01 14:58:17 +02:00
README.N1213 doc/README: documents and readme for NDS32 arch 2011-10-22 00:54:45 +02:00
README.nand nand: Add support for unlock.invert 2012-09-17 17:32:10 -05:00
README.nand-boot-ppc440 Fix some typos 2008-05-09 20:53:52 +02:00
README.NDS32 doc/README: documents and readme for NDS32 arch 2011-10-22 00:54:45 +02:00
README.ne2000 * Patches by Richard Woodruff, 01 Oct 2004: 2005-01-09 23:16:25 +00:00
README.NetConsole net: Make the netconsole buffer size configurable 2012-09-24 13:55:43 -05:00
README.ns9750dev * Patch by Markus Pietrek, 24 Feb 2004: 2004-02-26 23:46:20 +00:00
README.OFT Code cleanup, especially MIPS for GCC 4.x 2005-12-04 00:40:34 +01:00
README.omap-ulpi-viewport usb: ulpi: Add omap-ulpi-view port support 2012-02-12 10:11:30 +01:00
README.omap3 OMAP3: mvblx: Initial support for mvBlueLYNX-X 2011-11-04 13:54:33 -04:00
README.pblimage powerpc/CoreNet: add tool to support pbl image build. 2012-08-23 10:24:16 -05:00
README.POST post/i2c: Add ability to ignore I2C devices 2010-10-22 02:19:14 -05:00
README.ppc440 Remove unused CONFIG_SERIAL_SOFTWARE_FIFO feature 2010-09-23 09:02:05 +02:00
README.pxe PXE: FDT: Add support for fdt in PXE 2012-09-27 12:22:11 -05:00
README.rmobile rmobile: Add README 2012-10-03 02:04:26 +02:00
README.s5pc1xx s5pc1xx: update the README file 2010-04-03 15:24:26 -05:00
README.sata doc: english polishing for README.sata 2008-04-13 14:56:51 -07:00
README.sched * Patch by Arun Dharankar, 4 Apr 2003: 2003-04-05 00:53:31 +00:00
README.scrapyard MPC85xx: remove support for TQM85xx boards 2012-10-05 11:07:42 -07:00
README.serial_multi rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.sh sh: Add support Renesas Solutions R7780MP 2008-03-28 14:16:12 +09:00
README.sha1 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.silent rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.SNTP doc: Fix some typos in different files 2012-03-27 13:31:37 +02:00
README.spear SPEAr: Add configuration options for spear3xx and spear6xx boards 2012-07-07 14:07:40 +02:00
README.SPL SPL: Add support for loading image from ram in SPL. 2012-09-27 11:20:28 -07:00
README.srio-pcie-boot-corenet powerpc/corenet_ds: Update README and README.srio-pcie-boot-corenet 2012-08-23 10:24:15 -05:00
README.standalone doc/README: documents and readme for NDS32 arch 2011-10-22 00:54:45 +02:00
README.switch_config arm,davinci: update for enbw_cmc board 2012-07-07 14:07:21 +02:00
README.ubi Add UBI README 2010-10-19 23:53:45 +02:00
README.ublimage Minor coding style cleanup. 2011-09-11 21:24:09 +02:00
README.update add command fitupd to run an update from a FIT image 2011-07-26 16:58:48 +02:00
README.usb common: cosmetic: CONFIG_BOOTFILE checkpatch compliance 2011-10-22 01:21:35 +02:00
README.video video: parse the video-mode environment variable 2011-04-28 21:31:02 +02:00
README.VLAN Patches by Pantelis Antoniou, 30 Mar 2004: 2004-04-15 21:48:45 +00:00
README.zfs zfs: Add ZFS filesystem support 2012-08-09 23:42:20 +02:00

README.zfs 

This patch series adds support for ZFS listing and load to u-boot.

To Enable zfs ls and load commands, modify the board specific config file with
#define CONFIG_CMD_ZFS

Steps to test:

1. After applying the patch, zfs specific commands can be seen
   in the boot loader prompt using
        UBOOT #help

        zfsload- load binary file from a ZFS file system
        zfsls  - list files in a directory (default /)

2. To list the files in zfs pool, device or partition, execute
        zfsls <interface> <dev[:part]> [POOL/@/dir/file]
        For example:
        UBOOT #zfsls mmc 0:5 /rpool/@/usr/bin/

3. To read and load a file from an ZFS formatted partition to RAM, execute
        zfsload <interface> <dev[:part]> [addr] [filename] [bytes]
        For example:
        UBOOT #zfsload mmc 2:2 0x30007fc0 /rpool/@/boot/uImage

References :
	-- ZFS GRUB sources from Solaris GRUB-0.97
	-- GRUB Bazaar repository

Jorgen Lundman <lundman at lundman.net> 2012.