This is an archive of the discontinued LLVM Phabricator instance.

Differential D57429

[docs] Document ignoring build directory
AbandonedPublic

Authored by smeenai on Jan 29 2019, 5:22 PM.

Details

Reviewers
jyknight
mehdi_amini
Summary

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.

Diff Detail

Event Timeline

smeenai created this revision.Jan 29 2019, 5:22 PM
Harbormaster completed remote builds in B27479: Diff 184208.Jan 29 2019, 5:22 PM
pcc added a subscriber: pcc.Jan 29 2019, 5:24 PM
pcc added inline comments.
clang/www/get_started.html
66

I think this should be /build otherwise git will ignore files named build in every directory.

smeenai added a comment.Jan 29 2019, 5:24 PM

An alternative would be to just add build to our top-level .gitignore, assuming that's what most people are naming their build directory. @pcc attempted to do something a bit more ambitious in D57400, but just ignoring /build* (as suggested by @jyknight there) shouldn't cause issues, I think.

smeenai marked an inline comment as done.Jan 29 2019, 5:25 PM
smeenai added inline comments.
clang/www/get_started.html
66

You're right. I'll address this if we decide to go down this path vs. just adding to the .gitignore.

smeenai added a comment.Feb 12 2019, 10:23 PM

Ping.

Herald added a project: Restricted Project. · View Herald TranscriptFeb 12 2019, 10:23 PM
kristina added a subscriber: kristina.Feb 15 2019, 2:37 AM

I actually like the D57400 approach more, it's much easier to keep a list of known top level projects as a whitelist. There are many names people could give to such a build directory (out or build or b) not to mention any other cruft one may have there. (ie. I build a libc as part of toolchain build).

pcc mentioned this in D57400: Add a .gitignore file to the root that ignores any files outside of the project directories..Feb 15 2019, 9:13 AM
smeenai abandoned this revision.Apr 28 2022, 1:26 PM
Herald added a project: Restricted Project. · View Herald TranscriptApr 28 2022, 1:26 PM

Revision Contents

PathSize
clang/
www/
3 lines
llvm/
docs/
6 lines

Diff 184208

clang/www/get_started.html

Show First 20 Lines • Show All 55 Lines • ▼ Show 20 Lines<ol>
<li>Build LLVM and Clang: <li>Build LLVM and Clang:
<ul> <ul>
<li><tt>cd llvm-project</tt></li> <li><tt>cd llvm-project</tt></li>
<li><tt>mkdir build</tt> (in-tree build is not supported)</li> <li><tt>mkdir build</tt> (in-tree build is not supported)</li>
<li><tt>cd build</tt></li> <li><tt>cd build</tt></li>
<li><tt>cmake -DLLVM_ENABLE_PROJECTS=clang -G "Unix Makefiles" ../llvm</tt></li> <li><tt>cmake -DLLVM_ENABLE_PROJECTS=clang -G "Unix Makefiles" ../llvm</tt></li>
<li><tt>make</tt></li> <li><tt>make</tt></li>
<li>This builds both LLVM and Clang for debug mode.</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>
pccUnsubmitted
Not Done
ReplyInline Actions

I think this should be /build otherwise git will ignore files named build in every directory.

pcc: I think this should be `/build` otherwise git will ignore files named `build` in every…
smeenaiAuthorUnsubmitted
Done
ReplyInline Actions

You're right. I'll address this if we decide to go down this path vs. just adding to the .gitignore.

smeenai: You're right. I'll address this if we decide to go down this path vs. just adding to the `.
<li>Note: For subsequent Clang development, you can just run <li>Note: For subsequent Clang development, you can just run
<tt>make clang</tt>.</li> <tt>make clang</tt>.</li>
<li>CMake allows you to generate project files for several IDEs: Xcode, <li>CMake allows you to generate project files for several IDEs: Xcode,
Eclipse CDT4, CodeBlocks, Qt-Creator (use the CodeBlocks generator), Eclipse CDT4, CodeBlocks, Qt-Creator (use the CodeBlocks generator),
KDevelop3. For more details see KDevelop3. For more details see
<a href="https://llvm.org/docs/CMake.html">Building LLVM with CMake</a> <a href="https://llvm.org/docs/CMake.html">Building LLVM with CMake</a>
page.</li> page.</li>
</ul> </ul>
▲ Show 20 Lines • Show All 236 Lines • Show Last 20 Lines

llvm/docs/GettingStarted.rst

Show First 20 Lines • Show All 45 Lines • ▼ Show 20 Lines
#. Configure and build LLVM and Clang:. #. Configure and build LLVM and Clang:.
* ``cd llvm-project`` * ``cd llvm-project``
* ``mkdir build`` * ``mkdir build``
* ``cd build`` * ``cd build``
* ``cmake -G <generator> [options] ../llvm`` * ``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: Some common generators are:
* ``Ninja`` --- for generating `Ninja <https://ninja-build.org>`_ * ``Ninja`` --- for generating `Ninja <https://ninja-build.org>`_
build files. Most llvm developers use Ninja. build files. Most llvm developers use Ninja.
* ``Unix Makefiles`` --- for generating make-compatible parallel makefiles. * ``Unix Makefiles`` --- for generating make-compatible parallel makefiles.
* ``Visual Studio`` --- for generating Visual Studio projects and * ``Visual Studio`` --- for generating Visual Studio projects and
solutions. solutions.
* ``Xcode`` --- for generating Xcode projects. * ``Xcode`` --- for generating Xcode projects.
▲ Show 20 Lines • Show All 1,043 Lines • Show Last 20 Lines