[PATCH 00/12] documentation updates

[PATCH 00/12] documentation updates

[Holger Schurig]

Here are misc documentation updates.

BTW, I didn't change "filesystem" -> "file system", because "man mount" on
linux uses both spellings.  Apparently one can use whatever one wants.

I also was so liberate to rename some headings so that they don't start with
"barebox" anymore.  A lower-case starting heading is (in my eyes!) just
ugly, and if it isn't allowed to capitalize barebox than one can still
change the headline :-) Just for the chapter "barebox" (getting,
configuration, compiling) I haven't found a better name yet.

Holger Schurig (12):
  doc: .gitignore generated files
  doc: make "System setup" an appendix
  doc: start (almost) all headlines with a capital
  doc: only include own download chapter
  doc: filesystemtype -> filesystem type
  doc: mention "make xconfig"
  doc: add colon after NOTE and HINT
  doc: add hint on how to calculate in hush
  doc: remove board type from barebox prompt examples
  doc: reformat overly long lines
  doc: move variables near device parameters
  doc: link back from variables to device parameters

 .gitignore                                         |    2 ++
 Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst |    9 ++++--
 Documentation/boards/mxs/Chumby-Falconwing.rst     |   13 ++++++---
 Documentation/boards/mxs/Freescale-i.MX23-evk.rst  |    2 +-
 Documentation/boards/mxs/KaRo-TX28.rst             |    7 +++--
 Documentation/boards/omap.rst                      |    4 +--
 Documentation/boards/s3c/Digi-a9m2440.rst          |    2 +-
 Documentation/boards/tegra.rst                     |    4 +--
 Documentation/boards/x86.rst                       |   29 ++++++++++++++------
 Documentation/commands.rst                         |    4 +--
 Documentation/devicetree/index.rst                 |    2 +-
 Documentation/download.rst                         |   16 -----------
 Documentation/filesystems.rst                      |    2 +-
 Documentation/filesystems/ramfs.rst                |    6 ++--
 Documentation/index.rst                            |    1 -
 Documentation/user/barebox.rst                     |   10 ++++++-
 Documentation/user/booting-linux.rst               |    4 +--
 Documentation/user/driver-model.rst                |   14 ++++++----
 Documentation/user/hush.rst                        |   12 ++++++--
 Documentation/user/memory-areas.rst                |    2 +-
 Documentation/user/networking.rst                  |    6 ++--
 Documentation/user/pbl.rst                         |    2 +-
 Documentation/user/system-setup.rst                |    4 +--
 Documentation/user/ubi.rst                         |    2 +-
 Documentation/user/updating.rst                    |    2 +-
 Documentation/user/user-manual.rst                 |    8 +++---
 Documentation/user/variables.rst                   |   11 +++++---
 27 files changed, 105 insertions(+), 75 deletions(-)
 delete mode 100644 Documentation/download.rst

-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 01/12] doc: .gitignore generated files

[Holger Schurig]

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
 .gitignore |    2 ++
 1 file changed, 2 insertions(+)

diff --git a/.gitignore b/.gitignore
index 28f319a..135fdeb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -67,6 +67,8 @@ include/generated
 
 # Generated files
 Doxyfile.version
+Documentation/commands/*.rst
+doctrees/
 
 # stgit generated dirs
 patches-*
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 02/12] doc: make "System setup" an appendix

[Holger Schurig]

Note that I used "Appendix: " as text, because it looks like
python-sphinx doesn't know about appendices.

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
 Documentation/user/system-setup.rst |    4 ++--
 Documentation/user/user-manual.rst  |    2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/user/system-setup.rst b/Documentation/user/system-setup.rst
index 35d6147..683da9e 100644
--- a/Documentation/user/system-setup.rst
+++ b/Documentation/user/system-setup.rst
@@ -1,5 +1,5 @@
-System Setup
-============
+Appendix: System Setup
+======================
 
 Serial Console Access
 ---------------------
diff --git a/Documentation/user/user-manual.rst b/Documentation/user/user-manual.rst
index 4e2a250..fc97bac 100644
--- a/Documentation/user/user-manual.rst
+++ b/Documentation/user/user-manual.rst
@@ -10,7 +10,6 @@ Contents:
    :maxdepth: 2
 
    introduction
-   system-setup
    barebox
    networking
    automount
@@ -27,6 +26,7 @@ Contents:
    usb
    ubi
    booting-linux
+   system-setup
 
 * :ref:`search`
 * :ref:`genindex`
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 03/12] doc: start (almost) all headlines with a capital

[Holger Schurig]

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
 Documentation/boards/omap.rst        |    4 ++--
 Documentation/commands.rst           |    4 ++--
 Documentation/devicetree/index.rst   |    2 +-
 Documentation/filesystems.rst        |    2 +-
 Documentation/filesystems/ramfs.rst  |    2 +-
 Documentation/user/booting-linux.rst |    2 +-
 Documentation/user/hush.rst          |    4 ++--
 Documentation/user/memory-areas.rst  |    2 +-
 Documentation/user/networking.rst    |    2 +-
 Documentation/user/user-manual.rst   |    4 ++--
 10 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/Documentation/boards/omap.rst b/Documentation/boards/omap.rst
index 63caf66..56b7e64 100644
--- a/Documentation/boards/omap.rst
+++ b/Documentation/boards/omap.rst
@@ -7,8 +7,8 @@ both the first and the second stage loader. To build as a first stage loader
 build the \*_xload_defconfig for your board, for second stage build the normal
 \*_defconfig for your board.
 
-bootstrapping a panda board
----------------------------
+Bootstrapping a PandaBoard
+--------------------------
 
 The Panda board boots from SD card. The OMAP Boot ROM code loads a file named
 'MLO' on a bootable FAT partition on this card. There are several howtos and
diff --git a/Documentation/commands.rst b/Documentation/commands.rst
index a649209..55b04f6 100644
--- a/Documentation/commands.rst
+++ b/Documentation/commands.rst
@@ -1,5 +1,5 @@
-barebox command reference
-=========================
+Command reference
+=================
 
 .. toctree::
    :glob:
diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
index a24d635..abb9088 100644
--- a/Documentation/devicetree/index.rst
+++ b/Documentation/devicetree/index.rst
@@ -1,4 +1,4 @@
-barebox specific devicetree bindings
+Barebox specific devicetree bindings
 ====================================
 
 Contents:
diff --git a/Documentation/filesystems.rst b/Documentation/filesystems.rst
index 3bb1edf..4f7b398 100644
--- a/Documentation/filesystems.rst
+++ b/Documentation/filesystems.rst
@@ -1,6 +1,6 @@
 .. _filesystems:
 
-filesystems
+Filesystems
 ===========
 
 .. toctree::
diff --git a/Documentation/filesystems/ramfs.rst b/Documentation/filesystems/ramfs.rst
index 37d6ffc..c2e1e83 100644
--- a/Documentation/filesystems/ramfs.rst
+++ b/Documentation/filesystems/ramfs.rst
@@ -1,6 +1,6 @@
 .. index:: ramfs (filesystem)
 
-ram filesystem
+RAM filesystem
 ==============
 
 ramfs is a simple malloc based filesystem. An instance of ramfs is mounted during startup on /. The filesystemtype passed to mount is 'ramfs'
diff --git a/Documentation/user/booting-linux.rst b/Documentation/user/booting-linux.rst
index 561a850..4ae9d1b 100644
--- a/Documentation/user/booting-linux.rst
+++ b/Documentation/user/booting-linux.rst
@@ -197,7 +197,7 @@ The entry can be listed with the -l option:
 When on barebox the SD card shows up as ``mmc`` then this entry can be booted with
 ``boot mmc1`` or with setting ``global.boot.default`` to ``mmc1``.
 
-network boot
+Network boot
 ------------
 
 With the following steps barebox can start the Kernel and root filesystem
diff --git a/Documentation/user/hush.rst b/Documentation/user/hush.rst
index 4a1b84b..2a0e630 100644
--- a/Documentation/user/hush.rst
+++ b/Documentation/user/hush.rst
@@ -2,7 +2,7 @@
 
 .. _hush:
 
-hush shell
+Hush shell
 ==========
 
 barebox has an integrated shell: hush. This is a simple shell which
@@ -10,7 +10,7 @@ is enough for writing simple shell scripts. Usage of the shell for
 scripts should not be overstrained. Often a command written in C is
 more flexible and also more robust than a complicated shell script.
 
-hush features
+Hush features
 -------------
 
 variables::
diff --git a/Documentation/user/memory-areas.rst b/Documentation/user/memory-areas.rst
index dd1db9e..ab874c7 100644
--- a/Documentation/user/memory-areas.rst
+++ b/Documentation/user/memory-areas.rst
@@ -1,4 +1,4 @@
-memory areas
+Memory areas
 ============
 
 Several barebox commands like :ref:`command_md`, erase or crc work on an area
diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst
index 23b0e46..9c7bde4 100644
--- a/Documentation/user/networking.rst
+++ b/Documentation/user/networking.rst
@@ -1,4 +1,4 @@
-networking
+Networking
 ==========
 
 barebox has IPv4 networking support. Several protocols such as
diff --git a/Documentation/user/user-manual.rst b/Documentation/user/user-manual.rst
index fc97bac..aa6c083 100644
--- a/Documentation/user/user-manual.rst
+++ b/Documentation/user/user-manual.rst
@@ -1,7 +1,7 @@
 .. highlight:: console
 
-barebox user manual
-===================
+User manual
+===========
 
 Contents:
 
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 04/12] doc: only include own download chapter

[Holger Schurig]

Also make this download chapter note the next branch.

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
 Documentation/download.rst     |   16 ----------------
 Documentation/index.rst        |    1 -
 Documentation/user/barebox.rst |    7 ++++++-
 3 files changed, 6 insertions(+), 18 deletions(-)
 delete mode 100644 Documentation/download.rst

diff --git a/Documentation/download.rst b/Documentation/download.rst
deleted file mode 100644
index 9e30efe..0000000
--- a/Documentation/download.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-:: _download:
-
-Getting barebox
-===============
-
-Releases of barebox can be downloaded here:
-
-http://barebox.org/download/
-
-git
----
-
-The barebox development repository is available via `git <http://git-scm.com/>`_ here:
-
-  * clone address git://git.pengutronix.de/git/barebox.git
-  * git web http://git.pengutronix.de/?p=barebox.git;a=summary
diff --git a/Documentation/index.rst b/Documentation/index.rst
index aff450a..b7dae23 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -13,7 +13,6 @@ Contents:
    :numbered:
    :maxdepth: 1
 
-   download
    user/user-manual
    filesystems
    commands
diff --git a/Documentation/user/barebox.rst b/Documentation/user/barebox.rst
index 9eb34af..bab0260 100644
--- a/Documentation/user/barebox.rst
+++ b/Documentation/user/barebox.rst
@@ -16,7 +16,7 @@ http://www.barebox.org/download/
 Development versions of barebox are accessible via git. A local repository clone
 can be created using git::
 
-  git clone git://git.pengutronix.de/git/barebox.git
+  $ git clone git://git.pengutronix.de/git/barebox.git
   Cloning into 'barebox'...
   remote: Counting objects: 113356, done.
   remote: Compressing objects: 100% (25177/25177), done.
@@ -26,6 +26,11 @@ can be created using git::
   Checking connectivity... done.
   Checking out files: 100% (5651/5651), done.
 
+After this, make sure to check out needed branch. If you want to
+develop for barebox, it's better to check the the next branch::
+
+  $ git checkout -b next origin/remotes/next
+
 A web interface to the repository is available at
 http://git.pengutronix.de/?p=barebox.git.
 
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 05/12] doc: filesystemtype -> filesystem type

[Holger Schurig]

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
 Documentation/filesystems/ramfs.rst |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/filesystems/ramfs.rst b/Documentation/filesystems/ramfs.rst
index c2e1e83..2921a35 100644
--- a/Documentation/filesystems/ramfs.rst
+++ b/Documentation/filesystems/ramfs.rst
@@ -3,7 +3,7 @@
 RAM filesystem
 ==============
 
-ramfs is a simple malloc based filesystem. An instance of ramfs is mounted during startup on /. The filesystemtype passed to mount is 'ramfs'
+ramfs is a simple malloc based filesystem. An instance of ramfs is mounted during startup on /. The filesystem type passed to mount is 'ramfs'
 
 example::
 
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 06/12] doc: mention "make xconfig"

[Holger Schurig]

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
 Documentation/user/barebox.rst |    3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/user/barebox.rst b/Documentation/user/barebox.rst
index bab0260..70bdedc 100644
--- a/Documentation/user/barebox.rst
+++ b/Documentation/user/barebox.rst
@@ -100,6 +100,9 @@ with the most popular being ``menuconfig``::
 
   make menuconfig
 
+barebox used the same configuration system as Linux, so you can use
+all the things you know, e.g. ``make xconfig``, ``make allyesconfig`` etc.
+
 Compilation
 -----------
 
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 07/12] doc: add colon after NOTE and HINT

[Holger Schurig]

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
 Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst |    2 +-
 Documentation/boards/mxs/Chumby-Falconwing.rst     |    2 +-
 Documentation/boards/mxs/Freescale-i.MX23-evk.rst  |    2 +-
 Documentation/boards/mxs/KaRo-TX28.rst             |    4 ++--
 Documentation/boards/s3c/Digi-a9m2440.rst          |    2 +-
 Documentation/boards/tegra.rst                     |    4 ++--
 Documentation/boards/x86.rst                       |    6 +++---
 Documentation/user/booting-linux.rst               |    2 +-
 Documentation/user/driver-model.rst                |    2 +-
 Documentation/user/networking.rst                  |    2 +-
 Documentation/user/pbl.rst                         |    2 +-
 Documentation/user/ubi.rst                         |    2 +-
 Documentation/user/variables.rst                   |    2 +-
 13 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst b/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
index 527c490..1ea008f 100644
--- a/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
+++ b/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
@@ -33,6 +33,6 @@ Build the binary image::
 
   make ARCH=arm CROSS_COMPILE=armv5compiler
 
-**NOTE** Replace ''armv5compiler'' with your ARM v5 cross compiler, e.g.: ''arm-1136jfs-linux-gnueabi-''
+**NOTE:** replace ''armv5compiler'' with your ARM v5 cross compiler, e.g.: ''arm-1136jfs-linux-gnueabi-''
 
 The resulting binary image to be flashed will be barebox.bin, whereas the file named just barebox is an ELF executable for ARM.
diff --git a/Documentation/boards/mxs/Chumby-Falconwing.rst b/Documentation/boards/mxs/Chumby-Falconwing.rst
index 73e4c30..4cf4591 100644
--- a/Documentation/boards/mxs/Chumby-Falconwing.rst
+++ b/Documentation/boards/mxs/Chumby-Falconwing.rst
@@ -26,7 +26,7 @@ Build the bootloader binary image::
 
   make ARCH=arm CROSS_COMPILE=armv5compiler
 
-NOTE replace the armv5compiler with your ARM v5 cross compiler.
+**NOTE:** replace the armv5compiler with your ARM v5 cross compiler.
 
 How to prepare an MCI card to boot the "chumby one" with barebox
 ----------------------------------------------------------------
diff --git a/Documentation/boards/mxs/Freescale-i.MX23-evk.rst b/Documentation/boards/mxs/Freescale-i.MX23-evk.rst
index b03508c..a2cdc38 100644
--- a/Documentation/boards/mxs/Freescale-i.MX23-evk.rst
+++ b/Documentation/boards/mxs/Freescale-i.MX23-evk.rst
@@ -25,4 +25,4 @@ Build the bootloader binary image::
 
   make ARCH=arm CROSS_COMPILE=armv5compiler
 
-**NOTE** replace the armv5compiler with your ARM v5 cross compiler.
+**NOTE:** replace the armv5compiler with your ARM v5 cross compiler.
diff --git a/Documentation/boards/mxs/KaRo-TX28.rst b/Documentation/boards/mxs/KaRo-TX28.rst
index a6c308c..85d200b 100644
--- a/Documentation/boards/mxs/KaRo-TX28.rst
+++ b/Documentation/boards/mxs/KaRo-TX28.rst
@@ -31,9 +31,9 @@ Build the binary image::
 
   make ARCH=arm CROSS_COMPILE=armv5compiler
 
-**NOTE** replace the armv5compiler with your ARM v5 cross compiler.
+**NOTE:** replace the armv5compiler with your ARM v5 cross compiler.
 
-**NOTE** To use the result, you also need the following resources from Freescale:
+**NOTE:** to use the result, you also need the following resources from Freescale:
   * the 'bootlets' archive
   * the 'elftosb2' encryption tool
   * in the case you want to start @b barebox from an attached SD card the 'sdimage' tool from Freescale's 'uuc' archive.
diff --git a/Documentation/boards/s3c/Digi-a9m2440.rst b/Documentation/boards/s3c/Digi-a9m2440.rst
index 4ed8ae4..be3710a 100644
--- a/Documentation/boards/s3c/Digi-a9m2440.rst
+++ b/Documentation/boards/s3c/Digi-a9m2440.rst
@@ -64,4 +64,4 @@ Build the binary image::
 
   make ARCH=arm CROSS_COMPILE=armv4compiler
 
-**NOTE** replace the armv4compiler with your ARM v4 cross compiler.
+**NOTE:** replace the armv4compiler with your ARM v4 cross compiler.
diff --git a/Documentation/boards/tegra.rst b/Documentation/boards/tegra.rst
index f28c506..d2d1a25 100644
--- a/Documentation/boards/tegra.rst
+++ b/Documentation/boards/tegra.rst
@@ -14,7 +14,7 @@ multi-image build (:ref:`multi_image`). Building is as easy as typing:
   make ARCH=arm tegra_v7_defconfig
   make ARCH=arm CROSS_COMPILE=arm-v7-compiler-
 
-**NOTE** replace the arm-v7-compiler- with your ARM v7 cross compiler.
+**NOTE:** replace the arm-v7-compiler- with your ARM v7 cross compiler.
 
 Tegra images are specific to the bootsource. The build will generate images for
 all combinations of bootsources and supported boards. You can find the
@@ -69,7 +69,7 @@ You should now see barebox coming up on the serial console.
 Writing barebox to the primary boot device
 ------------------------------------------
 
-**NOTE** This may change in the near future to work with the standard
+**NOTE:** this may change in the near future to work with the standard
 barebox update mechanism (:ref:`update`).
 
 Copy the image corresponding to the primary boot device for your board to a
diff --git a/Documentation/boards/x86.rst b/Documentation/boards/x86.rst
index 5d38955..4e7ccd8 100644
--- a/Documentation/boards/x86.rst
+++ b/Documentation/boards/x86.rst
@@ -122,7 +122,7 @@ not exist::
         MBR               barebox                 first
                          main image              partition
 
-**NOTE** The  setupmbr tool is also working on real image file than on device
-      nodes only. So, there is no restriction what kind of file will be
-      modified.
+**NOTE:** the ``setupmbr`` tool is also working on real image file than on device
+nodes only. So, there is no restriction what kind of file will be
+modified.
 
diff --git a/Documentation/user/booting-linux.rst b/Documentation/user/booting-linux.rst
index 4ae9d1b..17427f3 100644
--- a/Documentation/user/booting-linux.rst
+++ b/Documentation/user/booting-linux.rst
@@ -48,7 +48,7 @@ variable:
   global.bootm.image=/path/to/zImage
   bootm
 
-**NOTE** It may happen that barebox is probed from the devicetree, but you have
+**NOTE:** it may happen that barebox is probed from the devicetree, but you have
 want to start a Kernel without passing a devicetree. In this case call ``oftree -f``
 to free the internal devicetree before calling ``bootm``
 
diff --git a/Documentation/user/driver-model.rst b/Documentation/user/driver-model.rst
index 2ec55f1..fae275e 100644
--- a/Documentation/user/driver-model.rst
+++ b/Documentation/user/driver-model.rst
@@ -87,5 +87,5 @@ device variables may have a type, so assigning wrong values may fail::
   barebox@Genesi Efika MX Smartbook:/ echo $?
   1
 
-**HINT** barebox has tab completion for variables. Typing ``eth0.<TAB><TAB>``
+**HINT:** barebox has tab completion for variables. Typing ``eth0.<TAB><TAB>``
 will show the parameters for eth0.
diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst
index 9c7bde4..c22685f 100644
--- a/Documentation/user/networking.rst
+++ b/Documentation/user/networking.rst
@@ -52,7 +52,7 @@ or
 
   mount -t nfs 192.168.2.1:/export none /mnt
 
-**NOTE** This can often be hidden behind the :ref:`command_automount` command to make
+**NOTE:** this can often be hidden behind the :ref:`command_automount` command to make
 mounting transparent to the user.
 
 Network console
diff --git a/Documentation/user/pbl.rst b/Documentation/user/pbl.rst
index a08d6c9..6757768 100644
--- a/Documentation/user/pbl.rst
+++ b/Documentation/user/pbl.rst
@@ -26,6 +26,6 @@ This way source code can be shared between regular barebox and PBL. A special
 case is ``lwl-y += file.o`` which expands to ``obj-y`` when PBL is disabled
 and to ``pbl-y`` when PBL is enabled.
 
-**HINT** For getting an overview over the binaries, disassemble barebox.bin
+**HINT:** for getting an overview over the binaries, disassemble barebox.bin
 (``make barebox.S``) with or without PBL support and also disassemble the
 PBL (``make arch/$ARCH/pbl/zbarebox.S``)
diff --git a/Documentation/user/ubi.rst b/Documentation/user/ubi.rst
index a2e386f..a187680 100644
--- a/Documentation/user/ubi.rst
+++ b/Documentation/user/ubi.rst
@@ -19,7 +19,7 @@ If you intend to use a device with UBI you should always use ``ubiformat`` inste
 :ref:`command_erase`. ``ubiformat`` will make sure the erasecounters are preserved and also
 :ref:`ubi_fastmap` won't work when a flash is erased with ``erase``
 
-NOTE: When using the :ref:`ubi_fastmap` feature make sure that the UBI is attached and detached
+**NOTE:** when using the :ref:`ubi_fastmap` feature make sure that the UBI is attached and detached
 once after using ``ubiformat``. This makes sure the Fastmap is written.
 
 After a device has been formatted it can be attached with :ref:`command_ubiattach`.
diff --git a/Documentation/user/variables.rst b/Documentation/user/variables.rst
index 04e1791..e349874 100644
--- a/Documentation/user/variables.rst
+++ b/Documentation/user/variables.rst
@@ -18,7 +18,7 @@ other variable. You can also directly assign a value during creation::
 
   global myvar1=foobar
 
-**NOTE** creating a variable with ``global myvar1=foobar`` looks very similar
+**NOTE:** creating a variable with ``global myvar1=foobar`` looks very similar
 to assigning a value with ``global.myvar1=foobar``, but the latter fails when
 a variable has not been created before.
 
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 08/12] doc: add hint on how to calculate in hush

[Holger Schurig]

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
 Documentation/user/hush.rst |    8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Documentation/user/hush.rst b/Documentation/user/hush.rst
index 2a0e630..ba4f062 100644
--- a/Documentation/user/hush.rst
+++ b/Documentation/user/hush.rst
@@ -50,3 +50,11 @@ example the :ref:`command_echo` command has the ``-a FILE`` option for appending
 a file and the ``-o FILE`` option for overwriting a file. The readline
 command requires a variable name as argument in which the line will be
 stored.
+
+**NOTE:** hust feels like a normal Unix shell, but it cannot calculate by
+itself, i.e. $(($A/2)) won't work. Calculation can however be done
+with :ref:`command_let`::
+
+  A=10
+  let B=$A/2
+  echo $B
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 09/12] doc: remove board type from barebox prompt examples

[Holger Schurig]

I kept however the one example that directly demos the bootup on an
Efika board.
---
 Documentation/user/driver-model.rst |   10 +++++-----
 Documentation/user/networking.rst   |    2 +-
 Documentation/user/updating.rst     |    2 +-
 Documentation/user/variables.rst    |    2 +-
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/user/driver-model.rst b/Documentation/user/driver-model.rst
index fae275e..ab7d292 100644
--- a/Documentation/user/driver-model.rst
+++ b/Documentation/user/driver-model.rst
@@ -34,7 +34,7 @@ handled with device detection. The user visible interface to device detection
 is the :ref:`command_detect` command. ``detect -l`` shows a list of detectable
 devices::
 
-  barebox@Genesi Efika MX Smartbook:/ detect -l
+  barebox:/ detect -l
   70004000.esdhc
   70008000.esdhc
   73f80000.usb
@@ -48,7 +48,7 @@ devices::
 
 A particular device can be detected with ``detect <devname>``::
 
-  barebox@Genesi Efika MX Smartbook:/ detect 73f80200.usb
+  barebox:/ detect 73f80200.usb
   Found SMSC USB331x ULPI transceiver (0x0424:0x0006).
   Bus 002 Device 004: ID 13d3:3273 802.11 n WLAN
   mdio_bus: miibus0: probed
@@ -67,7 +67,7 @@ additional information for a device. The parameters can be listed with the
 :ref:`command_devinfo` command. A ``devinfo <devicename>`` will print the parameters
 of a device::
 
-  barebox@Genesi Efika MX Smartbook:/ devinfo eth0
+  barebox:/ devinfo eth0
   Parameters:
     ipaddr: 192.168.23.197
     serverip: 192.168.23.1
@@ -82,9 +82,9 @@ The parameters can be used as shell variables::
 
 device variables may have a type, so assigning wrong values may fail::
 
-  barebox@Genesi Efika MX Smartbook:/ eth0.ipaddr="This is not an IP"
+  barebox:/ eth0.ipaddr="This is not an IP"
   set parameter: Invalid argument
-  barebox@Genesi Efika MX Smartbook:/ echo $?
+  barebox:/ echo $?
   1
 
 **HINT:** barebox has tab completion for variables. Typing ``eth0.<TAB><TAB>``
diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst
index c22685f..9c6eeb6 100644
--- a/Documentation/user/networking.rst
+++ b/Documentation/user/networking.rst
@@ -14,7 +14,7 @@ device is usually ``eth0``. The current configuration can be viewed with the
 
 .. code-block:: sh
 
-  barebox@Genesi Efika MX Smartbook:/ devinfo eth0
+  barebox:/ devinfo eth0
   Parameters:
     ipaddr: 192.168.23.197
     serverip: 192.168.23.1
diff --git a/Documentation/user/updating.rst b/Documentation/user/updating.rst
index 0503e7d..2a963b6 100644
--- a/Documentation/user/updating.rst
+++ b/Documentation/user/updating.rst
@@ -18,7 +18,7 @@ Updating barebox can be as easy as::
 Multiple handlers can be registered to the update mechanism. Usually the device
 barebox has been started from is registered as default (marked with a ``*``)::
 
-  barebox@Genesi Efika MX Smartbook:/ barebox_update -l
+  barebox:/ barebox_update -l
   registered update handlers:
   * mmc         -> /dev/mmc1
     spinor	-> /dev/m25p0
diff --git a/Documentation/user/variables.rst b/Documentation/user/variables.rst
index e349874..13477a0 100644
--- a/Documentation/user/variables.rst
+++ b/Documentation/user/variables.rst
@@ -33,7 +33,7 @@ Since it's hard to remember which variables these are and if the current
 barebox has support for them the :ref:`command_magicvar` command can print a list
 of all variables with special meaning along with a short description::
 
-  barebox@Genesi Efika MX Smartbook:/ magicvar
+  barebox:/ magicvar
   OPTARG                           optarg for hush builtin getopt
   PATH                             colon separated list of pathes to search for executables
   PS1                              hush prompt
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 10/12] doc: reformat overly long lines

[Holger Schurig]

Lines over 120 are just too long :-)

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
 Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst |    9 +++++---
 Documentation/boards/mxs/Chumby-Falconwing.rst     |   11 +++++++---
 Documentation/boards/mxs/KaRo-TX28.rst             |    3 ++-
 Documentation/boards/x86.rst                       |   23 +++++++++++++++-----
 Documentation/filesystems/ramfs.rst                |    4 +++-
 5 files changed, 37 insertions(+), 13 deletions(-)

diff --git a/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst b/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
index 1ea008f..45fd6be 100644
--- a/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
+++ b/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
@@ -6,7 +6,8 @@ The CPU module
 
 http://www.phytec.eu/europe/products/modules-overview/phycore/produktdetails/p/phycore-imx31-2.html
 
-This CPU card is based on a Freescale i.MX31 CPU. The card in configuration -0000REU is shipped with:
+This CPU card is based on a Freescale i.MX31 CPU. The card in
+configuration -0000REU is shipped with:
 
   * 128 MiB synchronous dynamic RAM (DDR type)
   * 64 MiB NAND flash
@@ -33,6 +34,8 @@ Build the binary image::
 
   make ARCH=arm CROSS_COMPILE=armv5compiler
 
-**NOTE:** replace ''armv5compiler'' with your ARM v5 cross compiler, e.g.: ''arm-1136jfs-linux-gnueabi-''
+**NOTE:** replace ''armv5compiler'' with your ARM v5 cross compiler,
+ e.g.: ''arm-1136jfs-linux-gnueabi-''
 
-The resulting binary image to be flashed will be barebox.bin, whereas the file named just barebox is an ELF executable for ARM.
+The resulting binary image to be flashed will be barebox.bin, whereas
+the file named just barebox is an ELF executable for ARM.
diff --git a/Documentation/boards/mxs/Chumby-Falconwing.rst b/Documentation/boards/mxs/Chumby-Falconwing.rst
index 4cf4591..79bff70 100644
--- a/Documentation/boards/mxs/Chumby-Falconwing.rst
+++ b/Documentation/boards/mxs/Chumby-Falconwing.rst
@@ -37,10 +37,15 @@ How to prepare an MCI card to boot the "chumby one" with barebox
     * the third one for the kernel (2 MiB ... 4 MiB in size)
     * the 4th one for the root filesystem which can fill the rest of the available space
 
-  * Mark the first partition with the partition ID "53" and copy the bootlets into this partition (currently not part of @b barebox!).
+  * Mark the first partition with the partition ID "53" and copy the
+    bootlets into this partition (currently not part of @b barebox!).
 
-  * Copy the default @b barebox environment into the second partition (no filesystem required).
+  * Copy the default @b barebox environment into the second partition
+    (no filesystem required).
 
   * Copy the kernel into the third partition (no filesystem required).
 
-  * Create the root filesystem in the 4th partition. You may copy an image into this partition or you can do it in the classic way: mkfs on it, mount it and copy all required data and programs into it.
+  * Create the root filesystem in the 4th partition. You may copy an
+    image into this partition or you can do it in the classic way:
+    mkfs on it, mount it and copy all required data and programs into
+    it.
diff --git a/Documentation/boards/mxs/KaRo-TX28.rst b/Documentation/boards/mxs/KaRo-TX28.rst
index 85d200b..15984d7 100644
--- a/Documentation/boards/mxs/KaRo-TX28.rst
+++ b/Documentation/boards/mxs/KaRo-TX28.rst
@@ -36,7 +36,8 @@ Build the binary image::
 **NOTE:** to use the result, you also need the following resources from Freescale:
   * the 'bootlets' archive
   * the 'elftosb2' encryption tool
-  * in the case you want to start @b barebox from an attached SD card the 'sdimage' tool from Freescale's 'uuc' archive.
+  * in the case you want to start @b barebox from an attached SD card
+    the 'sdimage' tool from Freescale's 'uuc' archive.
 
 Memory layout when barebox is running
 -------------------------------------
diff --git a/Documentation/boards/x86.rst b/Documentation/boards/x86.rst
index 4e7ccd8..ee5e869 100644
--- a/Documentation/boards/x86.rst
+++ b/Documentation/boards/x86.rst
@@ -16,11 +16,24 @@ Restrictions
 Due to some BIOS and barebox restrictions the boot media must be
 prepared in some special way:
 
-  * barebox must be stored in the MBR (Master Boot Record) of the boot media. Currently its not possible to store and boot it in one of the partition sectors  to use it as a second stage loader). This is no eternal restriction. It only needs further effort to add this feature.
-  * barebox currently cannot run a chained boot loader. Also, this is no external restriction, only further effort needed.
-  * barebox comes with limited filesystem support. There is currently no support for the most common and popular filesystems used in the \*NIX world. This restricts locations where to store a kernel and other runtime information
-  * barebox must be stored to the first n sectors of the boot media. To ensure this does not collide with partitions on the boot media, the first partition must start at a sector behind the ones barebox occupies.
-  * barebox handles its runtime configuration in a special way: It stores it in a binary way into some reserved sectors ("persistant storage").
+  * barebox must be stored in the MBR (Master Boot Record) of the boot
+    media. Currently its not possible to store and boot it in one of
+    the partition sectors to use it as a second stage loader). This is
+    no eternal restriction. It only needs further effort to add this
+    feature.
+  * barebox currently cannot run a chained boot loader. Also, this is
+    no external restriction, only further effort needed.
+  * barebox comes with limited filesystem support. There is currently
+    no support for the most common and popular filesystems used in the
+    \*NIX world. This restricts locations where to store a kernel and
+    other runtime information
+  * barebox must be stored to the first n sectors of the boot media.
+    To ensure this does not collide with partitions on the boot media,
+    the first partition must start at a sector behind the ones barebox
+    occupies.
+  * barebox handles its runtime configuration in a special way: It
+    stores it in a binary way into some reserved sectors ("persistant
+    storage").
 
 Boot Preparations
 -----------------
diff --git a/Documentation/filesystems/ramfs.rst b/Documentation/filesystems/ramfs.rst
index 2921a35..70e7282 100644
--- a/Documentation/filesystems/ramfs.rst
+++ b/Documentation/filesystems/ramfs.rst
@@ -3,7 +3,9 @@
 RAM filesystem
 ==============
 
-ramfs is a simple malloc based filesystem. An instance of ramfs is mounted during startup on /. The filesystem type passed to mount is 'ramfs'
+ramfs is a simple malloc based filesystem. An instance of ramfs is
+mounted during startup on /. The filesystem type passed to mount is
+'ramfs'
 
 example::
 
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 11/12] doc: move variables near device parameters

[Holger Schurig]

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
 Documentation/user/user-manual.rst |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/user/user-manual.rst b/Documentation/user/user-manual.rst
index aa6c083..0eac0aa 100644
--- a/Documentation/user/user-manual.rst
+++ b/Documentation/user/user-manual.rst
@@ -15,9 +15,9 @@ Contents:
    automount
    memory-areas
    driver-model
+   variables
    hush
    defaultenv-2
-   variables
    updating
    devicetree
    pbl
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

[PATCH 12/12] doc: link back from variables to device parameters

[Holger Schurig]

Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
---
 Documentation/user/driver-model.rst |    2 ++
 Documentation/user/variables.rst    |    7 +++++--
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/Documentation/user/driver-model.rst b/Documentation/user/driver-model.rst
index ab7d292..f4b3bb9 100644
--- a/Documentation/user/driver-model.rst
+++ b/Documentation/user/driver-model.rst
@@ -59,6 +59,8 @@ A particular device can be detected with ``detect <devname>``::
 
 For detecting all devices ``detect -a`` can be used.
 
+.. _device_parameters:
+
 Device parameters
 -----------------
 
diff --git a/Documentation/user/variables.rst b/Documentation/user/variables.rst
index 13477a0..1aced28 100644
--- a/Documentation/user/variables.rst
+++ b/Documentation/user/variables.rst
@@ -1,5 +1,8 @@
-Configuration variables
-=======================
+Variables
+=========
+
+We already have seen some variables in :ref:`device_parameters`. But
+there is more to variables.
 
 .. _global_device:
 
-- 
1.7.10.4


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: [PATCH 00/12] documentation updates

[Sascha Hauer]

On Fri, Jun 27, 2014 at 01:00:09PM +0200, Holger Schurig wrote:
> Here are misc documentation updates.
> 
> BTW, I didn't change "filesystem" -> "file system", because "man mount" on
> linux uses both spellings.  Apparently one can use whatever one wants.
> 
> I also was so liberate to rename some headings so that they don't start with
> "barebox" anymore.  A lower-case starting heading is (in my eyes!) just
> ugly, and if it isn't allowed to capitalize barebox than one can still
> change the headline :-) 

:)

Applied, thanks

Sascha

-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox