[llvm] 9a9d56e - [Docs] Mention clone depth feature of git in LLVM getting started

[via llvm-commits]

Author: xgupta
Date: 2021-02-24T10:56:10+05:30
New Revision: 9a9d56eb3e69219f6bafc02c396fb6584b54114f

URL: https://github.com/llvm/llvm-project/commit/9a9d56eb3e69219f6bafc02c396fb6584b54114f
DIFF: https://github.com/llvm/llvm-project/commit/9a9d56eb3e69219f6bafc02c396fb6584b54114f.diff

LOG: [Docs] Mention clone depth feature of git in LLVM getting started

The current size of the llvm-project repository exceeds 1 GB. A shallow clone can save a lot of space and time. Some developers might not aware of this feature.

Reviewed By: awarzynski

Differential Revision: https://reviews.llvm.org/D97118

Added: 
    

Modified: 
    llvm/docs/GettingStarted.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst
index a2274f80fc1f..4b9a1e236f24 100644
--- a/llvm/docs/GettingStarted.rst
+++ b/llvm/docs/GettingStarted.rst
@@ -38,6 +38,10 @@ This is an example workflow and configuration to get and build the LLVM source:
    * ``git clone https://github.com/llvm/llvm-project.git``
    * Or, on windows, ``git clone --config core.autocrlf=false
      https://github.com/llvm/llvm-project.git``
+   * To save storage and speed-up the checkout time, you may want to do a 
+     `shallow clone <https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---depthltdepthgt>`_. 
+     For example, to get the latest revision of the LLVM project, use 
+     ``git clone --depth 1 https://github.com/llvm/llvm-project.git``
 
 #. Configure and build LLVM and Clang: