[clang] 67ee2f8 - Added a faster method to clone llvm project [DOCS]

[via cfe-commits]

Author: Sushma Unnibhavi
Date: 2021-05-05T21:37:53+05:30
New Revision: 67ee2f870d3b06a5684251272eae36d6e0f519b0

URL: https://github.com/llvm/llvm-project/commit/67ee2f870d3b06a5684251272eae36d6e0f519b0
DIFF: https://github.com/llvm/llvm-project/commit/67ee2f870d3b06a5684251272eae36d6e0f519b0.diff

LOG: Added a faster method to clone llvm project [DOCS]

Reviewed By: xgupta, amccarth

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

Added: 
    

Modified: 
    clang/www/get_started.html

Removed: 
    


################################################################################
diff  --git a/clang/www/get_started.html b/clang/www/get_started.html
index aacf55af8f574..40a05d92fb491 100755
--- a/clang/www/get_started.html
+++ b/clang/www/get_started.html
@@ -51,6 +51,17 @@ <h3 id="buildNix">On Unix-like Systems</h3>
   <ul>
     <li>Change directory to where you want the llvm directory placed.</li>
     <li><tt>git clone https://github.com/llvm/llvm-project.git</tt></li>
+    <li>The above command is very slow. It can be made faster by creating a shallow clone. Shallow clone saves storage and speeds up the checkout time. This is done by using the command:
+      <ul>
+        <li><tt>git clone --depth=1 https://github.com/llvm/llvm-project.git (using this only the latest version of llvm can be built)</tt></li>
+        <li>For normal users looking to just compile, this command works fine. But if someone later becomes a contributor, since they can't push code from a shallow clone, it needs to be converted into a full clone:
+          <ul>
+            <li><tt>cd llvm-project</tt></li>
+            <li><tt>git fetch --unshallow</tt></li>
+          </ul>
+        </li>
+      </ul>
+    </li>
   </ul>
   </li>
   <li>Build LLVM and Clang: