Update docs and release notes for Repo --depth

buildbot · Apr 17, 2014 · 0ebdc73 · 0ebdc73
1 parent b1b07eb
commit 0ebdc73
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/master/docs/manual/cfg-buildsteps.rst b/master/docs/manual/cfg-buildsteps.rst
@@ -906,6 +906,11 @@ The Repo step takes the following arguments:
     (optional, defaults to ``False``): renderable boolean to control whether ``repo``
     syncs all branches. i.e. ``repo sync -c``
 
+``depth``
+    (optional, defaults to 0): Depth argument passed to repo init.
+    Specifies the amount of git history to store. A depth of 1 is useful for shallow clones.
+    This can save considerable disk space on very large projects.
+
 ``updateTarballAge``
     (optional, defaults to "one week"):
     renderable to control the policy of updating of the tarball

diff --git a/master/docs/relnotes/index.rst b/master/docs/relnotes/index.rst
@@ -155,6 +155,8 @@ Features
 
 * A new argument ``summaryCB`` has been added to ``GerritStatusPush``, to allow sending one review per buildset. Sending a single "summary" review per buildset is now the default if neither ``summaryCB`` nor ``reviewCB`` are specified.
 
+* ::bb:step:`Repo` now supports a ``depth`` flag when initializing the repo. This controls the amount of git history to download.
+
 Forward Compatibility
 ~~~~~~~~~~~~~~~~~~~~~