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

[Shivam Gupta via Phabricator via cfe-commits]

This revision was automatically updated to reflect the committed changes.
Closed by commit rG67ee2f870d3b: Added a faster method to clone llvm project [DOCS] (authored by sushmaunnibhavi, committed by xgupta).
Herald added a project: clang.
Herald added a subscriber: cfe-commits.

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D101433/new/

https://reviews.llvm.org/D101433

Files:
  clang/www/get_started.html


Index: clang/www/get_started.html
===================================================================
--- clang/www/get_started.html
+++ clang/www/get_started.html
@@ -51,6 +51,17 @@
   <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:


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D101433.343075.patch
Type: text/x-patch
Size: 1123 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20210505/860a731f/attachment-0001.bin>