summaryrefslogtreecommitdiff
path: root/doc/build
diff options
context:
space:
mode:
authorHeinrich Schuchardt <xypron.glpk@gmx.de>2020-09-05 10:58:52 +0200
committerTom Rini <trini@konsulko.com>2020-09-12 10:53:01 -0400
commit2974ba4f65f839bee9ba202c0b61e24071f55721 (patch)
tree16aabc87efcb08db5048ead95bcd5c8ab2c00854 /doc/build
parent75fb7b9163b9dc01828a3a519d2de0b19a6f23f2 (diff)
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>
Diffstat (limited to 'doc/build')
-rw-r--r--doc/build/index.rst1
-rw-r--r--doc/build/source.rst30
2 files changed, 31 insertions, 0 deletions
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..75720e2027
--- /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