From: Heinrich Schuchardt <xypron.glpk@gmx.de>
Date: Sat, 5 Sep 2020 08:58:52 +0000 (+0200)
Subject: doc: describe source repository
X-Git-Tag: v2020.10-rc5~11^2~3
X-Git-Url: http://git.openpandora.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2974ba4f65f839bee9ba202c0b61e24071f55721;p=pandora-u-boot.git

doc: describe source repository

Add a chapter to the HTML documentation describing how to retrieve the
U-Boot sources.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---

diff --git a/doc/build/index.rst b/doc/build/index.rst
index e0072afb5e8..5051a97e701 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 00000000000..75720e20275
--- /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