Fix Documentation build warnings

Fix Documentation build warnings

[Sascha Hauer]

There are so many warnings during build of the documentation
that one probably doesn't realize when he adds even more. Fix
all these.

Sascha

----------------------------------------------------------------
Sascha Hauer (7):
      Documentation: arm-qemu-vexpress: Fix too short underline
      Documentation: Change many code blocks to no highlight
      Documentation: socfpga: Fix numbered list
      Documentation: change default highlight language to shell
      Documentation: defaultenv-2: Change highlight to make
      Documentation: remove :numbered: from lower level toctrees
      ARM: psci command: Add to misc group

 Documentation/boards/am335x.rst                    |  1 -
 Documentation/boards/arm-qemu-vexpress.rst         |  2 +-
 Documentation/boards/cirrus-logic.rst              |  1 -
 Documentation/boards/imx.rst                       |  1 -
 Documentation/boards/mips.rst                      |  1 -
 Documentation/boards/mvebu.rst                     |  1 -
 Documentation/boards/mxs.rst                       |  1 -
 Documentation/boards/openrisc.rst                  |  4 ++-
 Documentation/boards/powerpc.rst                   |  1 -
 Documentation/boards/pxa.rst                       |  1 -
 Documentation/boards/rk3288.rst                    |  1 -
 Documentation/boards/samsung.rst                   |  1 -
 Documentation/boards/socfpga.rst                   | 22 ++++++------
 Documentation/boards/x86.rst                       | 18 ++++++----
 Documentation/conf.py                              |  2 +-
 .../bindings/barebox/barebox,environment.rst       |  4 ++-
 .../devicetree/bindings/misc/fsl,imx-iim.rst       |  4 ++-
 .../devicetree/bindings/misc/fsl,imx-ocotp.rst     |  4 ++-
 Documentation/devicetree/index.rst                 |  1 -
 Documentation/filesystems/pstore.rst               | 40 +++++++++++++---------
 Documentation/user/defaultenv-2.rst                |  4 ++-
 Documentation/user/user-manual.rst                 |  1 -
 arch/arm/cpu/psci.c                                |  5 +--
 23 files changed, 66 insertions(+), 55 deletions(-)

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

[PATCH 1/7] Documentation: arm-qemu-vexpress: Fix too short underline

[Sascha Hauer]

Fixes sphinx warning about too short underline.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
 Documentation/boards/arm-qemu-vexpress.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/boards/arm-qemu-vexpress.rst b/Documentation/boards/arm-qemu-vexpress.rst
index dcbac8e625..010eae04a2 100644
--- a/Documentation/boards/arm-qemu-vexpress.rst
+++ b/Documentation/boards/arm-qemu-vexpress.rst
@@ -1,5 +1,5 @@
 QEMU vexpress
-=======
+=============
 
 ARM Qemu vexpress
 -----------------
-- 
2.11.0


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

[PATCH 2/7] Documentation: Change many code blocks to no highlight

[Sascha Hauer]

Several blocks cannot be sensibly highlighted, so change the highliting
to 'none'. Fixes many warnings in building the documentation.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
 Documentation/boards/openrisc.rst                  |  4 ++-
 Documentation/boards/x86.rst                       | 18 ++++++----
 .../bindings/barebox/barebox,environment.rst       |  4 ++-
 .../devicetree/bindings/misc/fsl,imx-iim.rst       |  4 ++-
 .../devicetree/bindings/misc/fsl,imx-ocotp.rst     |  4 ++-
 Documentation/filesystems/pstore.rst               | 40 +++++++++++++---------
 6 files changed, 47 insertions(+), 27 deletions(-)

diff --git a/Documentation/boards/openrisc.rst b/Documentation/boards/openrisc.rst
index cc00a5d8ea..fe6c48c958 100644
--- a/Documentation/boards/openrisc.rst
+++ b/Documentation/boards/openrisc.rst
@@ -12,7 +12,9 @@ Compile or1ksim emulator::
  $ ./configure
  $ make
 
-Create minimal or1ksim.cfg file::
+Create minimal or1ksim.cfg file:
+
+.. code-block:: none
 
  section cpu
    ver = 0x12
diff --git a/Documentation/boards/x86.rst b/Documentation/boards/x86.rst
index ee5e86980f..d0528a3280 100644
--- a/Documentation/boards/x86.rst
+++ b/Documentation/boards/x86.rst
@@ -47,9 +47,10 @@ Keep Sectors free
 
 Build the barebox image and check its size. At least this amount of
 sectors must be kept free after the MBR prior the first partition. Do this
-simple calulation::
+simple calulation:
 
-	sectors = (\<size of barebox image\> + 511) / 512
+.. code-block:: none
+  sectors = (\<size of barebox image\> + 511) / 512
 
 To be able to store the runtime configuration, further free sectors are
 required. Its up to you and your requirements, how large this persistant
@@ -60,8 +61,9 @@ For this example we are reserving 300 sectors for the barebox image and
 additionaly 32 sectors for the persistant storage. So, the first partition on
 the boot media must start at sector 333 or later.
 
-Run the  fdisk tool to setup such a partition table::
+Run the  fdisk tool to setup such a partition table:
 
+.. code-block:: none
 
   [jb@host]~> fdisk /dev/sda
   Command (m for help): p
@@ -74,7 +76,7 @@ Run the  fdisk tool to setup such a partition table::
 
 Change the used units to  sectors for easier handling.
 
-::
+.. code-block:: none
 
   Command (m for help): u
   Changing display/entry units to sectors
@@ -87,7 +89,9 @@ Change the used units to  sectors for easier handling.
   
   Device Boot      Start         End      Blocks   Id  System
 
-Now its possible to create the first partition with the required offset::
+Now its possible to create the first partition with the required offset:
+
+.. code-block:: none
 
   Command (m for help): n
   Command action
@@ -128,7 +132,9 @@ The barebox image gets stored on the boot media like this::
                 storage               main image              partition
 
 If the  -s option is omitted, the "persistant storage" part simply does
-not exist::
+not exist:
+
+.. code-block:: none
 
   sector 0   1                              333
          |---|--------------- ~~~ ------------|--------------
diff --git a/Documentation/devicetree/bindings/barebox/barebox,environment.rst b/Documentation/devicetree/bindings/barebox/barebox,environment.rst
index 12b103be10..029e7f04a4 100644
--- a/Documentation/devicetree/bindings/barebox/barebox,environment.rst
+++ b/Documentation/devicetree/bindings/barebox/barebox,environment.rst
@@ -26,7 +26,9 @@ The file-path is the name of a file located in a FAT filesystem on the
 device named in device-path.  This filesystem will be mounted and the
 environment loaded from the file's location in the directory tree.
 
-Example::
+Example:
+
+.. code-block:: none
 
   environment@0 {
   	compatible = "barebox,environment";
diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst b/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst
index b9d5bcba98..1fa4735db8 100644
--- a/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst
+++ b/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst
@@ -12,7 +12,9 @@ Optional properties:
   can be multiple entries in the form <&phandle bankno fuseofs> to assign a MAC
   address to an Ethernet device.
 
-Example::
+Example:
+
+.. code-block:: none
 
   iim: iim@83f98000 {
   	compatible = "fsl,imx51-iim", "fsl,imx27-iim";
diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
index 403863e927..202bb3aa07 100644
--- a/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
+++ b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst
@@ -12,7 +12,9 @@ Optional properties:
   can be multiple entries in the form <&phandle regofs> to assign a MAC
   address to an Ethernet device.
 
-Example::
+Example:
+
+.. code-block:: none
 
   ocotp1: ocotp@021bc000 {
   	compatible = "fsl,imx6q-ocotp";
diff --git a/Documentation/filesystems/pstore.rst b/Documentation/filesystems/pstore.rst
index 0f3a2239e3..8eee374bdd 100644
--- a/Documentation/filesystems/pstore.rst
+++ b/Documentation/filesystems/pstore.rst
@@ -11,7 +11,9 @@ pstore is a filesystem to store kernel log or kernel panic messages. These
 messages are stored by the kernel in a specified RAM area which is never
 overwritten by any user. This data can be accessed after a reboot through
 /pstore in Barebox or the kernel. The pstore filesystem is automatically mounted
-at boot::
+at boot:
+
+.. code-block:: none
 
 	none on / type ramfs
 	none on /dev type devfs
@@ -20,21 +22,23 @@ at boot::
 pstore may add additional warnings during boot due to wrong ECCs (no data
 written)::
 
-	persistent_ram: found existing invalid buffer, size 791282217, start 1116786789
-	persistent_ram: uncorrectable error in header
-	persistent_ram: found existing invalid buffer, size 791282281, start 1133564005
-	persistent_ram: uncorrectable error in header
-	persistent_ram: found existing invalid buffer, size 791347753, start 1133564005
-	persistent_ram: uncorrectable error in header
-	persistent_ram: found existing invalid buffer, size 791347753, start 1133572197
-	persistent_ram: uncorrectable error in header
-	persistent_ram: found existing invalid buffer, size 774505001, start 1133564005
-	persistent_ram: uncorrectable error in header
-	persistent_ram: found existing invalid buffer, size 791282281, start 1133564005
-	persistent_ram: uncorrectable error in header
-	persistent_ram: found existing invalid buffer, size 791282217, start 1133564005
-	pstore: Registered ramoops as persistent store backend
-	ramoops: attached 0x200000@0x1fdf4000, ecc: 16/0
+.. code-block:: none
+
+  persistent_ram: found existing invalid buffer, size 791282217, start 1116786789
+  persistent_ram: uncorrectable error in header
+  persistent_ram: found existing invalid buffer, size 791282281, start 1133564005
+  persistent_ram: uncorrectable error in header
+  persistent_ram: found existing invalid buffer, size 791347753, start 1133564005
+  persistent_ram: uncorrectable error in header
+  persistent_ram: found existing invalid buffer, size 791347753, start 1133572197
+  persistent_ram: uncorrectable error in header
+  persistent_ram: found existing invalid buffer, size 774505001, start 1133564005
+  persistent_ram: uncorrectable error in header
+  persistent_ram: found existing invalid buffer, size 791282281, start 1133564005
+  persistent_ram: uncorrectable error in header
+  persistent_ram: found existing invalid buffer, size 791282217, start 1133564005
+  pstore: Registered ramoops as persistent store backend
+  ramoops: attached 0x200000@0x1fdf4000, ecc: 16/0
 
 To use pstore/RAMOOPS both Barebox and Kernel have to be compiled with pstore
 and RAM backend support. The kernel receives the parameters describing the
@@ -44,7 +48,9 @@ RAMOOPS parameters for the Kernel are stored in the variable
 global.linux.bootargs.ramoops.
 
 To see where the RAMOOPS area is located, you can execute iomem in Barebox. The
-RAMOOPS area is listed as 'persistent ram'::
+RAMOOPS area is listed as 'persistent ram':
+
+.. code-block:: none
 
   0x10000000 - 0x1fffffff (size 0x10000000) ram0
     0x17e7c0c0 - 0x1fcf817f (size 0x07e7c0c0) malloc space
-- 
2.11.0


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

[PATCH 3/7] Documentation: socfpga: Fix numbered list

[Sascha Hauer]

This is no code block, change to numbered list.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
 Documentation/boards/socfpga.rst | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/Documentation/boards/socfpga.rst b/Documentation/boards/socfpga.rst
index 2b6c8a5b16..cd0fffa1ee 100644
--- a/Documentation/boards/socfpga.rst
+++ b/Documentation/boards/socfpga.rst
@@ -104,17 +104,17 @@ The boardspecific files for `arch/arm/boards/<yourboard>` are:
 * sequencer_auto_inst_init.c
 * sequencer_defines.h
 
-To update the handoff files, the following procedure is necessary::
-
- 1. Regenerate the project with Qsys
- 2. Load up your project in Quartus II and assemble the design
- 3. Go to the SoCEDS installation and run
-    ``./embedded_command_shell.sh``
- 4. Now run ``bsp-editor``
- 5. Create a new BSP
- 6. Select the directory `hps_isw_handoff/soc_system_hps_0` under the
-    preloader settings directory
- 7. Click ``Ok`` than ``Generate``
+To update the handoff files, the following procedure is necessary:
+
+1. Regenerate the project with Qsys
+2. Load up your project in Quartus II and assemble the design
+3. Go to the SoCEDS installation and run
+   ``./embedded_command_shell.sh``
+4. Now run ``bsp-editor``
+5. Create a new BSP
+6. Select the directory `hps_isw_handoff/soc_system_hps_0` under the
+   preloader settings directory
+7. Click ``Ok`` than ``Generate``
 
 Now run the command::
 
-- 
2.11.0


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

[PATCH 4/7] Documentation: change default highlight language to shell

[Sascha Hauer]

There are many places where sphinx complains that blocks cannot
be hilghlighted in 'c' and in fact I am not aware of any C code
snippets in the documentation, so change the default highlighting
style to shell which fits our needs much better. With this we
get rid of many warnings while building the documentation.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
 Documentation/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 0292c720a7..dbd4a80caa 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -259,4 +259,4 @@ texinfo_documents = [
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
 
-highlight_language = 'c'
+highlight_language = 'sh'
-- 
2.11.0


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

[PATCH 5/7] Documentation: defaultenv-2: Change highlight to make

[Sascha Hauer]

It's a make snippet, so change highlighting accordingly.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
 Documentation/user/defaultenv-2.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/user/defaultenv-2.rst b/Documentation/user/defaultenv-2.rst
index faeeb81fbd..db74176b03 100644
--- a/Documentation/user/defaultenv-2.rst
+++ b/Documentation/user/defaultenv-2.rst
@@ -30,7 +30,9 @@ same file exists in a later overlay, it will overwrite the preceding one.
 Note that not all of the above directories will necessarily be
 included in your default environment, it depends on your barebox
 configuration settings. You can see the configuration variables
-and their respective included directories in ``defaultenv/Makefile``::
+and their respective included directories in ``defaultenv/Makefile``:
+
+.. code-block:: make
 
   bbenv-$(CONFIG_DEFAULT_ENVIRONMENT_GENERIC_NEW) += defaultenv-2-base
   bbenv-$(CONFIG_DEFAULT_ENVIRONMENT_GENERIC_NEW_MENU) += defaultenv-2-menu
-- 
2.11.0


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

[PATCH 6/7] Documentation: remove :numbered: from lower level toctrees

[Sascha Hauer]

Only the highest level toctree may have :numbered:, otherwise
sphinxs complains loudly that the subtree is already numbered.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
 Documentation/boards/am335x.rst       | 1 -
 Documentation/boards/cirrus-logic.rst | 1 -
 Documentation/boards/imx.rst          | 1 -
 Documentation/boards/mips.rst         | 1 -
 Documentation/boards/mvebu.rst        | 1 -
 Documentation/boards/mxs.rst          | 1 -
 Documentation/boards/powerpc.rst      | 1 -
 Documentation/boards/pxa.rst          | 1 -
 Documentation/boards/rk3288.rst       | 1 -
 Documentation/boards/samsung.rst      | 1 -
 Documentation/devicetree/index.rst    | 1 -
 Documentation/user/user-manual.rst    | 1 -
 12 files changed, 12 deletions(-)

diff --git a/Documentation/boards/am335x.rst b/Documentation/boards/am335x.rst
index 6972020179..8d726e4a10 100644
--- a/Documentation/boards/am335x.rst
+++ b/Documentation/boards/am335x.rst
@@ -52,7 +52,6 @@ AM335x Boards
 
 .. toctree::
   :glob:
-  :numbered:
   :maxdepth: 1
 
   am335x/*
diff --git a/Documentation/boards/cirrus-logic.rst b/Documentation/boards/cirrus-logic.rst
index 95a961e244..8e0ffbb136 100644
--- a/Documentation/boards/cirrus-logic.rst
+++ b/Documentation/boards/cirrus-logic.rst
@@ -3,7 +3,6 @@ Cirrus Logic edb9xxx
 
 .. toctree::
   :glob:
-  :numbered:
   :maxdepth: 1
 
   edb9xxx/*
diff --git a/Documentation/boards/imx.rst b/Documentation/boards/imx.rst
index b6e65060c7..704aa027b6 100644
--- a/Documentation/boards/imx.rst
+++ b/Documentation/boards/imx.rst
@@ -125,7 +125,6 @@ or ``imx_defconfig`` instead.
 
 .. toctree::
   :glob:
-  :numbered:
   :maxdepth: 1
 
   imx/*
diff --git a/Documentation/boards/mips.rst b/Documentation/boards/mips.rst
index 4bac35ffdb..f3287a25a6 100644
--- a/Documentation/boards/mips.rst
+++ b/Documentation/boards/mips.rst
@@ -3,7 +3,6 @@ MIPS
 
 .. toctree::
   :glob:
-  :numbered:
   :maxdepth: 1
 
   mips/*
diff --git a/Documentation/boards/mvebu.rst b/Documentation/boards/mvebu.rst
index b28fd443b6..e27aa28306 100644
--- a/Documentation/boards/mvebu.rst
+++ b/Documentation/boards/mvebu.rst
@@ -54,7 +54,6 @@ Not all supported boards have a description here.
 
 .. toctree::
   :glob:
-  :numbered:
   :maxdepth: 1
 
   mvebu/*
diff --git a/Documentation/boards/mxs.rst b/Documentation/boards/mxs.rst
index 82f23216dd..feb024227a 100644
--- a/Documentation/boards/mxs.rst
+++ b/Documentation/boards/mxs.rst
@@ -125,7 +125,6 @@ Not all supported boards have a description here.
 
 .. toctree::
   :glob:
-  :numbered:
   :maxdepth: 1
 
   mxs/*
diff --git a/Documentation/boards/powerpc.rst b/Documentation/boards/powerpc.rst
index 94b272c61d..81312eb16f 100644
--- a/Documentation/boards/powerpc.rst
+++ b/Documentation/boards/powerpc.rst
@@ -5,7 +5,6 @@ Not all supported boards have a description here.
 
 .. toctree::
   :glob:
-  :numbered:
   :maxdepth: 1
 
   powerpc/*
diff --git a/Documentation/boards/pxa.rst b/Documentation/boards/pxa.rst
index da848a0958..61453a178d 100644
--- a/Documentation/boards/pxa.rst
+++ b/Documentation/boards/pxa.rst
@@ -5,7 +5,6 @@ Not all supported boards have a description here.
 
 .. toctree::
   :glob:
-  :numbered:
   :maxdepth: 1
 
   pxa/*
diff --git a/Documentation/boards/rk3288.rst b/Documentation/boards/rk3288.rst
index 3acca74302..ef93fb3b83 100644
--- a/Documentation/boards/rk3288.rst
+++ b/Documentation/boards/rk3288.rst
@@ -51,7 +51,6 @@ RK3288 Boards
 
 .. toctree::
   :glob:
-  :numbered:
   :maxdepth: 1
 
   rk3288/*
diff --git a/Documentation/boards/samsung.rst b/Documentation/boards/samsung.rst
index d75224f780..f6f341301d 100644
--- a/Documentation/boards/samsung.rst
+++ b/Documentation/boards/samsung.rst
@@ -3,7 +3,6 @@ Samsung S3C/S5P
 
 .. toctree::
   :glob:
-  :numbered:
   :maxdepth: 1
 
   s3c/*
diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst
index de571547e0..c6309defdf 100644
--- a/Documentation/devicetree/index.rst
+++ b/Documentation/devicetree/index.rst
@@ -5,7 +5,6 @@ Contents:
 
 .. toctree::
    :glob:
-   :numbered:
    :maxdepth: 1
 
    bindings/barebox/*
diff --git a/Documentation/user/user-manual.rst b/Documentation/user/user-manual.rst
index 791c8e0979..516b760b1b 100644
--- a/Documentation/user/user-manual.rst
+++ b/Documentation/user/user-manual.rst
@@ -6,7 +6,6 @@ User manual
 Contents:
 
 .. toctree::
-   :numbered:
    :maxdepth: 2
 
    introduction
-- 
2.11.0


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

[PATCH 7/7] ARM: psci command: Add to misc group

[Sascha Hauer]

Explicitly add psci command to the misc group to get rid of
the warning that the command has no group.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
 arch/arm/cpu/psci.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/arch/arm/cpu/psci.c b/arch/arm/cpu/psci.c
index eafb361a0a..0a7e48f8fe 100644
--- a/arch/arm/cpu/psci.c
+++ b/arch/arm/cpu/psci.c
@@ -303,7 +303,8 @@ BAREBOX_CMD_HELP_OPT ("-z",  "Turn off secondary CPU core")
 BAREBOX_CMD_HELP_END
 
 BAREBOX_CMD_START(smc)
-        .cmd            = do_smc,
-        BAREBOX_CMD_DESC("secure monitor test command")
+	.cmd = do_smc,
+	BAREBOX_CMD_DESC("secure monitor test command")
+	BAREBOX_CMD_GROUP(CMD_GRP_MISC)
 BAREBOX_CMD_END
 #endif
\ No newline at end of file
-- 
2.11.0


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