[PATCH] D57429: [docs] Document ignoring build directory

[Shoaib Meenai via Phabricator via llvm-commits]

smeenai created this revision.
smeenai added reviewers: jyknight, mehdi_amini.

Users might not know about `.git/info/exclude`, which can be used to
ignore a directory locally (whereas changes to `.gitignore` would
themselves pollute `git status`). Explicitly note this in LLVM and
clang's getting started documentation.


https://reviews.llvm.org/D57429

Files:
  clang/www/get_started.html
  llvm/docs/GettingStarted.rst


Index: llvm/docs/GettingStarted.rst
===================================================================
--- llvm/docs/GettingStarted.rst
+++ llvm/docs/GettingStarted.rst
@@ -51,6 +51,12 @@
    * ``cd build``
    * ``cmake -G <generator> [options] ../llvm``
 
+     Note that git will not ignore the ``build`` directory by default. You can
+     add it to ``.git/info/exclude`` to ignore it:
+
+     * ``cd llvm-project``
+     * ``echo build >> .git/info/exclude``
+
      Some common generators are:
 
      * ``Ninja`` --- for generating `Ninja <https://ninja-build.org>`_
Index: clang/www/get_started.html
===================================================================
--- clang/www/get_started.html
+++ clang/www/get_started.html
@@ -61,6 +61,9 @@
     <li><tt>cmake -DLLVM_ENABLE_PROJECTS=clang -G "Unix Makefiles" ../llvm</tt></li>
     <li><tt>make</tt></li>
     <li>This builds both LLVM and Clang for debug mode.</li>
+    <li>Note: git does not ignore the build directory by default. You can add it
+        to <tt>.git/info/exclude</tt> to ignore it:
+        <tt>cd llvm-project && echo build >> .git/info/exclude</tt></li>
     <li>Note: For subsequent Clang development, you can just run
         <tt>make clang</tt>.</li>
     <li>CMake allows you to generate project files for several IDEs: Xcode,


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D57429.184208.patch
Type: text/x-patch
Size: 1320 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190130/e26cdaf5/attachment.bin>