A little bit fixing and extending the existing documentation

A little bit fixing and extending the existing documentation

[Juergen Borleis]

Just some minor changes...

jbe


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

[PATCH 1/9] Docs: just fix a typo

[Juergen Borleis]

Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
---
 Documentation/boards/imx.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/boards/imx.rst b/Documentation/boards/imx.rst
index 0fde3e7..21ea825 100644
--- a/Documentation/boards/imx.rst
+++ b/Documentation/boards/imx.rst
@@ -91,7 +91,7 @@ command for writing to NAND flash.
 i.MX boards
 -----------
 
-Not supported all boards have a description here. Many newer boards also do
+Not all supported boards have a description here. Many newer boards also do
 not have individual defconfig files, they are covered by ``imx_v7_defconfig``
 or ``imx_defconfig`` instead.
 
-- 
2.1.4


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

[PATCH 2/9] Docs: just mark the 'bootm' command like the 'go' command as well

[Juergen Borleis]

Just a try to be consistent in one sentence.

Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
---
 Documentation/boards/mxs.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/boards/mxs.rst b/Documentation/boards/mxs.rst
index 6c8bdb5..879663c 100644
--- a/Documentation/boards/mxs.rst
+++ b/Documentation/boards/mxs.rst
@@ -115,5 +115,5 @@ mxsboot tool which changes this sector number in the image.
 Booting second stage
 --------------------
 
-The second stage images can be started with the barebox bootm command or
+The second stage images can be started with the barebox 'bootm' command or
 just jumped into using the 'go' command.
-- 
2.1.4


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

[PATCH 3/9] Docs: add some info about the Ka-Ro TX25 related bootloader images

[Juergen Borleis]

Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
---
 Documentation/boards/imx/Karo-TX25.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 Documentation/boards/imx/Karo-TX25.rst

diff --git a/Documentation/boards/imx/Karo-TX25.rst b/Documentation/boards/imx/Karo-TX25.rst
new file mode 100644
index 0000000..756c99d
--- /dev/null
+++ b/Documentation/boards/imx/Karo-TX25.rst
@@ -0,0 +1,10 @@
+Ka-Ro TX25
+==========
+
+Building the bootloader image for this target is covered by the ``imx_defconfig``
+multiimage configuration if the ``System Type`` menu entry ``Ka-Ro TX25``
+is enabled.
+
+Use the corresponding ``barebox-karo-tx25.img`` for external NAND boot.
+Use the corresponding ``barebox-karo-tx25-internal.img`` for internal NAND, USB
+or SD card boot.
-- 
2.1.4


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

[PATCH 4/9] Docs: add some info about the Phytec's phyCORE27 and phyCARD27 related bootloader images

[Juergen Borleis]

Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
---
 Documentation/boards/imx/Phytec-phyCARD-i.MX27.rst | 8 ++++++++
 Documentation/boards/imx/Phytec-phyCORE-i.MX27.rst | 8 ++++++++
 2 files changed, 16 insertions(+)
 create mode 100644 Documentation/boards/imx/Phytec-phyCARD-i.MX27.rst
 create mode 100644 Documentation/boards/imx/Phytec-phyCORE-i.MX27.rst

diff --git a/Documentation/boards/imx/Phytec-phyCARD-i.MX27.rst b/Documentation/boards/imx/Phytec-phyCARD-i.MX27.rst
new file mode 100644
index 0000000..d5d3837
--- /dev/null
+++ b/Documentation/boards/imx/Phytec-phyCARD-i.MX27.rst
@@ -0,0 +1,8 @@
+Phytec phyCARD-i.MX27
+=====================
+
+Building the bootloader image for this target is covered by the ``imx_defconfig``
+multiimage configuration if the ``System Type`` menu entry ``phyCard-i.MX27``
+is enabled.
+
+Use the corresponding ``barebox-phytec-phycard-imx27.img`` file for this target.
diff --git a/Documentation/boards/imx/Phytec-phyCORE-i.MX27.rst b/Documentation/boards/imx/Phytec-phyCORE-i.MX27.rst
new file mode 100644
index 0000000..4b40be7
--- /dev/null
+++ b/Documentation/boards/imx/Phytec-phyCORE-i.MX27.rst
@@ -0,0 +1,8 @@
+Phytec phyCORE-i.MX27
+=====================
+
+Building the bootloader image for this target is covered by the ``imx_defconfig``
+multiimage configuration if the ``System Type`` menu entry ``phyCORE-i.MX27``
+is enabled.
+
+Use the corresponding ``barebox-phytec-phycore-imx27.img`` file for this target.
-- 
2.1.4


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

[PATCH 5/9] Docs: extend the mentioned commands with a link to their documentation

[Juergen Borleis]

Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
---
 Documentation/boards/mxs.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/boards/mxs.rst b/Documentation/boards/mxs.rst
index 879663c..1c26826 100644
--- a/Documentation/boards/mxs.rst
+++ b/Documentation/boards/mxs.rst
@@ -115,5 +115,5 @@ mxsboot tool which changes this sector number in the image.
 Booting second stage
 --------------------
 
-The second stage images can be started with the barebox 'bootm' command or
-just jumped into using the 'go' command.
+The second stage images can be started with the barebox :ref:`command_bootm` command or
+just jumped into using the :ref:`command_go` command.
-- 
2.1.4


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

[PATCH 6/9] Docs: move the individual MXS target documentation where they belong to

[Juergen Borleis]

i.MX and MXS differs in their global documentation. Honor this.

Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
---
 Documentation/boards/imx.rst |  1 -
 Documentation/boards/mxs.rst | 12 ++++++++++++
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/Documentation/boards/imx.rst b/Documentation/boards/imx.rst
index 21ea825..466f69c 100644
--- a/Documentation/boards/imx.rst
+++ b/Documentation/boards/imx.rst
@@ -101,4 +101,3 @@ or ``imx_defconfig`` instead.
   :maxdepth: 1
 
   imx/*
-  mxs/*
diff --git a/Documentation/boards/mxs.rst b/Documentation/boards/mxs.rst
index 1c26826..cfcd4c7 100644
--- a/Documentation/boards/mxs.rst
+++ b/Documentation/boards/mxs.rst
@@ -117,3 +117,15 @@ Booting second stage
 
 The second stage images can be started with the barebox :ref:`command_bootm` command or
 just jumped into using the :ref:`command_go` command.
+
+i.MXs boards
+------------
+
+Not all supported boards have a description here.
+
+.. toctree::
+  :glob:
+  :numbered:
+  :maxdepth: 1
+
+  mxs/*
-- 
2.1.4


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

[PATCH 7/9] Docs: the name of the default config file for the FSL i.MX23 evk has changed

[Juergen Borleis]

Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
---
 Documentation/boards/mxs/Freescale-i.MX23-evk.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/boards/mxs/Freescale-i.MX23-evk.rst b/Documentation/boards/mxs/Freescale-i.MX23-evk.rst
index 85dde46..cb73ec1 100644
--- a/Documentation/boards/mxs/Freescale-i.MX23-evk.rst
+++ b/Documentation/boards/mxs/Freescale-i.MX23-evk.rst
@@ -21,7 +21,7 @@ How to get the bootloader binary image
 
 Using the default configuration::
 
-  make ARCH=arm imx23evk_defconfig
+  make ARCH=arm freescale-mx23-evk_defconfig
 
 Build the bootloader binary image::
 
-- 
2.1.4


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

[PATCH 8/9] Docs: extend the mentioned commands with a link to their documentation

[Juergen Borleis]

Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
---
 Documentation/boards/mxs/KaRo-TX28.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/boards/mxs/KaRo-TX28.rst b/Documentation/boards/mxs/KaRo-TX28.rst
index 0c5dc71..6cad5eb 100644
--- a/Documentation/boards/mxs/KaRo-TX28.rst
+++ b/Documentation/boards/mxs/KaRo-TX28.rst
@@ -38,5 +38,5 @@ This produces the following images:
 
  * barebox-karo-tx28-bootstream.img - Use with the bcb command
  * barebox-karo-tx28-sd.img - Use for SD cards
- * barebox-karo-tx28-2nd.img - Use for 2nd stage booting (with bootm)
+ * barebox-karo-tx28-2nd.img - Use for 2nd stage booting (with :ref:`command_bootm`)
 
-- 
2.1.4


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

[PATCH 9/9] Docs: add some info about the Olimex's Olinuxino related bootloader images

[Juergen Borleis]

Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
---
 Documentation/boards/mxs/Olimex-olinuxino.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Documentation/boards/mxs/Olimex-olinuxino.rst

diff --git a/Documentation/boards/mxs/Olimex-olinuxino.rst b/Documentation/boards/mxs/Olimex-olinuxino.rst
new file mode 100644
index 0000000..a06eb33
--- /dev/null
+++ b/Documentation/boards/mxs/Olimex-olinuxino.rst
@@ -0,0 +1,26 @@
+Olimex LTD Olinuxino
+====================
+
+The CPU module
+--------------
+
+This CPU module is based on a Freescale i.MX23 CPU.
+
+How to get the bootloader binary image
+--------------------------------------
+
+Using the default configuration::
+
+  make ARCH=arm imx233-olinuxino_defconfig
+
+Build the binary image::
+
+  make ARCH=arm CROSS_COMPILE=armv5compiler
+
+**NOTE:** replace the armv5compiler with your ARM v5 cross compiler.
+
+This produces the following images:
+
+ * barebox-olinuxino-imx23-bootstream.img - Use with the bcb command
+ * barebox-olinuxino-imx23-sd.img - Use for SD cards
+ * barebox-olinuxino-imx23-2nd.img - Use for 2nd stage booting (with :ref:`command_bootm`)
-- 
2.1.4


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

Re: [PATCH 2/9] Docs: just mark the 'bootm' command like the 'go' command as well

[Lucas Stach]

Am Montag, den 26.01.2015, 11:39 +0100 schrieb Juergen Borleis:
> Just a try to be consistent in one sentence.
> 
> Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
> ---
>  Documentation/boards/mxs.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/boards/mxs.rst b/Documentation/boards/mxs.rst
> index 6c8bdb5..879663c 100644
> --- a/Documentation/boards/mxs.rst
> +++ b/Documentation/boards/mxs.rst
> @@ -115,5 +115,5 @@ mxsboot tool which changes this sector number in the image.
>  Booting second stage
>  --------------------
>  
> -The second stage images can be started with the barebox bootm command or
> +The second stage images can be started with the barebox 'bootm' command or
>  just jumped into using the 'go' command.

Wouldn't it be better to directly link to those commands by
using :ref:`command_bootm` (same for go), like in other parts of the
documentation?

Regards,
Lucas


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

Re: [PATCH 2/9] Docs: just mark the 'bootm' command like the 'go' command as well

[Lucas Stach]

Am Montag, den 26.01.2015, 11:46 +0100 schrieb Lucas Stach:
> Am Montag, den 26.01.2015, 11:39 +0100 schrieb Juergen Borleis:
> > Just a try to be consistent in one sentence.
> > 
> > Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
> > ---
> >  Documentation/boards/mxs.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/boards/mxs.rst b/Documentation/boards/mxs.rst
> > index 6c8bdb5..879663c 100644
> > --- a/Documentation/boards/mxs.rst
> > +++ b/Documentation/boards/mxs.rst
> > @@ -115,5 +115,5 @@ mxsboot tool which changes this sector number in the image.
> >  Booting second stage
> >  --------------------
> >  
> > -The second stage images can be started with the barebox bootm command or
> > +The second stage images can be started with the barebox 'bootm' command or
> >  just jumped into using the 'go' command.
> 
> Wouldn't it be better to directly link to those commands by
> using :ref:`command_bootm` (same for go), like in other parts of the
> documentation?
> 
And I just noticed you do exactly that in Patch 5/9.



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

Re: A little bit fixing and extending the existing documentation

[Sascha Hauer]

On Mon, Jan 26, 2015 at 11:39:47AM +0100, Juergen Borleis wrote:
> Just some minor changes...

Thanks. Applied all but the second patch.

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

Re: A little bit fixing and extending the existing documentation

[Sascha Hauer]

On Fri, Feb 27, 2015 at 03:07:28PM +0100, Juergen Borleis wrote:
> This time I changed two older platforms to the new default environment and
> added some more documentation snippets.
> 
> The result of the change to the new default environment was tested on real
> targets.

Applied all, 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

A little bit fixing and extending the existing documentation

[Juergen Borleis]

This time I changed two older platforms to the new default environment and
added some more documentation snippets.

The result of the change to the new default environment was tested on real
targets.

Regards,
Juergen


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