From a6ab59d179b58bf9d27560e13d69e11ea9127bf4 Mon Sep 17 00:00:00 2001 From: Antony Pavlov Date: Sat, 12 Jul 2014 00:26:22 +0400 Subject: Documentation: add virt2real barebox mini-howto Signed-off-by: Antony Pavlov Signed-off-by: Sascha Hauer --- Documentation/boards/davinci.rst | 51 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 Documentation/boards/davinci.rst (limited to 'Documentation') diff --git a/Documentation/boards/davinci.rst b/Documentation/boards/davinci.rst new file mode 100644 index 0000000000..a2ddc3c41f --- /dev/null +++ b/Documentation/boards/davinci.rst @@ -0,0 +1,51 @@ +TI Davinci +========== + +virt2real +--------- + +virt2real is a miniature board for creation of WiFi +or Internet controllable smart devices. + +The board has + + * TI DaVinchi DM365 running at 300 MHz; + * 128 MiB DDR2 SDRAM; + * 256 MiB NAND Flash Memory; + * 2 x UART serial interfaces; + * 1 x Ethernet interface (Micrel KS8851); + * 1 x USB interface; + * microSD card slot. + +The board uses U-Boot as bootloader. + + +Running barebox +^^^^^^^^^^^^^^^ + + 1. Connect to the boards's UART0 (115200 8N1); + Use J2.2 (GND), J2.4 (UART0_TXD), J2.6 (UART0_RXD) pins. + + 2. Turn board's power on; + + 3. Wait for ``Hit any key to stop autoboot`` prompt and press the space key. + + 4. Upload ``barebox.bin`` via Ymodem + +.. code-block:: none + virt2real ># loady +.. + + 5. Run barebox + +.. code-block:: none + virt2real ># go 0x82000000 +.. + + +Links +^^^^^ + + * http://virt2real.com/ + * http://wiki.virt2real.ru/ + * https://github.com/virt2real -- cgit v1.2.3 From c949b66674a8e625db0e75c522efce5597b42255 Mon Sep 17 00:00:00 2001 From: Jan Luebbe Date: Fri, 11 Jul 2014 20:51:58 +0200 Subject: Documentation: use command groups The help definition already contained a group declaration. This is now reused for the HTML documentation. Signed-off-by: Jan Luebbe Signed-off-by: Sascha Hauer --- Documentation/commands.rst | 86 ++++++++++++++++++++++++++++++++++++++++++- Documentation/gen_commands.py | 13 ++++++- 2 files changed, 95 insertions(+), 4 deletions(-) (limited to 'Documentation') diff --git a/Documentation/commands.rst b/Documentation/commands.rst index 55b04f6e56..0dc9e1bcf4 100644 --- a/Documentation/commands.rst +++ b/Documentation/commands.rst @@ -1,9 +1,91 @@ Command reference ================= +Information +----------- .. toctree:: + :titlesonly: :glob: - :maxdepth: 1 - commands/* + commands/info/* + +Booting +------- +.. toctree:: + :titlesonly: + :glob: + + commands/boot/* + +Partitions and Filesystems +-------------------------- +.. toctree:: + :titlesonly: + :glob: + + commands/part/* + +Environment +----------- +.. toctree:: + :titlesonly: + :glob: + + commands/env/* + +Files +----- +.. toctree:: + :titlesonly: + :glob: + + commands/file/* + +Shell Scripting +--------------- +.. toctree:: + :titlesonly: + :glob: + + commands/script/* + +Console and Framebuffer +----------------------- +.. toctree:: + :titlesonly: + :glob: + + commands/console/* + +Memory +------ +.. toctree:: + :titlesonly: + :glob: + + commands/mem/* + +Hardware Manipulation +--------------------- +.. toctree:: + :titlesonly: + :glob: + + commands/hwmanip/* + +Miscelleanous +------------- +.. toctree:: + :titlesonly: + :glob: + + commands/misc/* + +Networking +---------- +.. toctree:: + :titlesonly: + :glob: + + commands/net/* diff --git a/Documentation/gen_commands.py b/Documentation/gen_commands.py index 4e33ccaea6..d3db350bf7 100755 --- a/Documentation/gen_commands.py +++ b/Documentation/gen_commands.py @@ -1,5 +1,6 @@ #!/usr/bin/python +import errno import os import re import sys @@ -76,7 +77,7 @@ def parse_c(name): x = CMD_GROUP.match(line) if x: last = cmd['c_group'] - last.append(x.group(1).decode("string_escape")) + last.append(x.group(1).split('_')[-1].lower()) continue x = CONT.match(line) if x: @@ -159,6 +160,14 @@ for name in CMDS.keys(): for name, cmd in CMDS.items(): #pprint({name: cmd}) rst = gen_rst(name, cmd) - target = os.path.join(sys.argv[2], name+'.rst') + subdir = os.path.join(sys.argv[2], cmd['c_group'][0]) + try: + os.makedirs(subdir) + except OSError as e: + if e.errno == errno.EEXIST and os.path.isdir(subdir): + pass + else: + raise + target = os.path.join(subdir, name+'.rst') file(target, 'w').write(rst) -- cgit v1.2.3 From 46e8bf74874809846c366ca6bfc542076e17770d Mon Sep 17 00:00:00 2001 From: Holger Schurig Date: Tue, 22 Jul 2014 09:56:47 +0200 Subject: Documentation: only write changed *.rst files Documentation/gen_commands.py use to re-write all auto-generated *.rst file, changed or not. That in turn didn't work well with the internal cache of the Sphinx documentation generator. By comparing the SHA1 hash of the newly generated *.rst with the current sha1 file, the time to execute "make docs" can be reduced from 6.2s to 2.4s on my humble laptop. Signed-off-by: Sascha Hauer --- Documentation/gen_commands.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'Documentation') diff --git a/Documentation/gen_commands.py b/Documentation/gen_commands.py index d3db350bf7..eadea9e189 100755 --- a/Documentation/gen_commands.py +++ b/Documentation/gen_commands.py @@ -4,6 +4,7 @@ import errno import os import re import sys +import hashlib from collections import defaultdict from pprint import pprint @@ -169,5 +170,18 @@ for name, cmd in CMDS.items(): else: raise target = os.path.join(subdir, name+'.rst') + + # Only write the new rst if it differs from the old one. Wroto + hash_old = hashlib.sha1() + try: + f = open(target, 'rb') + hash_old.update(f.read()) + except: + pass + hash_new = hashlib.sha1() + hash_new.update(rst) + if hash_old.hexdigest() == hash_new.hexdigest(): + continue + file(target, 'w').write(rst) -- cgit v1.2.3 From 2f0f5522a8c21e8ded9eefae2691e174d713f6b4 Mon Sep 17 00:00:00 2001 From: Holger Schurig Date: Tue, 22 Jul 2014 09:56:48 +0200 Subject: Documentation: change generated help lines Someone loadx (load binary file over serial line (X-Modem)) looked more silly than loadx - load binary file over serial line (X-Modem) Signed-off-by: Holger Schurig Signed-off-by: Sascha Hauer --- Documentation/gen_commands.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation') diff --git a/Documentation/gen_commands.py b/Documentation/gen_commands.py index eadea9e189..b85e2e3eab 100755 --- a/Documentation/gen_commands.py +++ b/Documentation/gen_commands.py @@ -103,7 +103,7 @@ def gen_rst(name, cmd): out.append('.. _command_%s:' % name) out.append('') if 'c_desc' in cmd: - out.append("%s (%s)" % (name, ''.join(cmd['c_desc']).strip())) + out.append("%s - %s" % (name, ''.join(cmd['c_desc']).strip())) else: out.append("%s" % (name,)) out.append('='*len(out[-1])) -- cgit v1.2.3 From 8df8a3d7a9d3356183df0a45c97f32dac878b65b Mon Sep 17 00:00:00 2001 From: Ezequiel Garcia Date: Sat, 2 Aug 2014 10:12:26 -0300 Subject: trivial: Correct word spelling, s/miscelleanous/miscellaneous Signed-off-by: Ezequiel Garcia Signed-off-by: Sascha Hauer --- Documentation/commands.rst | 2 +- commands/Kconfig | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation') diff --git a/Documentation/commands.rst b/Documentation/commands.rst index 0dc9e1bcf4..261af2a078 100644 --- a/Documentation/commands.rst +++ b/Documentation/commands.rst @@ -73,7 +73,7 @@ Hardware Manipulation commands/hwmanip/* -Miscelleanous +Miscellaneous ------------- .. toctree:: :titlesonly: diff --git a/commands/Kconfig b/commands/Kconfig index 61816f5115..b03f74a82b 100644 --- a/commands/Kconfig +++ b/commands/Kconfig @@ -1859,7 +1859,7 @@ endmenu -menu "Miscelleanous" +menu "Miscellaneous" config CMD_2048 tristate @@ -1976,7 +1976,7 @@ config CMD_TIME Note: This command depends on COMMAND being interruptible, otherwise the timer may overrun resulting in incorrect results -# end Miscelleanous commands +# end Miscellaneous commands endmenu -- cgit v1.2.3