diff mbox series

[1/2] doc: describe source repository

Message ID 20200905085853.29081-2-xypron.glpk@gmx.de
State Accepted
Commit 2974ba4f65f839bee9ba202c0b61e24071f55721
Delegated to: Tom Rini
Headers show
Series doc: describe building with GCC | expand

Commit Message

Heinrich Schuchardt Sept. 5, 2020, 8:58 a.m. UTC 
Add a chapter to the HTML documentation describing how to retrieve the
U-Boot sources.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 doc/build/index.rst  |  1 +
 doc/build/source.rst | 30 ++++++++++++++++++++++++++++++
 2 files changed, 31 insertions(+)
 create mode 100644 doc/build/source.rst

--
2.28.0

Comments

Tom Rini Sept. 14, 2020, 7:41 p.m. UTC | #1 
On Sat, Sep 05, 2020 at 10:58:52AM +0200, Heinrich Schuchardt wrote:

> Add a chapter to the HTML documentation describing how to retrieve the
> U-Boot sources.
> 
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

Applied to u-boot/master, thanks!
diff mbox series

Patch

diff --git a/doc/build/index.rst b/doc/build/index.rst
index e0072afb5e..5051a97e70 100644
--- a/doc/build/index.rst
+++ b/doc/build/index.rst
@@ -6,5 +6,6 @@  Build U-Boot
 .. toctree::
    :maxdepth: 2

+   source
    clang
    tools
diff --git a/doc/build/source.rst b/doc/build/source.rst
new file mode 100644
index 0000000000..4627c1f79e
--- /dev/null
+++ b/doc/build/source.rst
@@ -0,0 +1,30 @@ 
+Obtaining the source
+=====================
+
+The source of the U-Boot project is maintained in a Git repository.
+
+You can download the source via
+
+.. code-block:: bash
+
+    git clone https://gitlab.denx.de/u-boot/u-boot.git
+
+A mirror of the source is maintained on Github
+
+.. code-block:: bash
+
+    git clone https://github.com/u-boot/u-boot
+
+The released versions are available as tags which use the naming scheme::
+
+    v<year>.<month>
+
+Release candidates are named::
+
+    v<year>.<month>-rc<number>
+
+To checkout the October 2020 release you would use:
+
+.. code-block:: bash
+
+    git checkout v2020.10