Page MenuHomePhabricator

[docs] Document ignoring build directory
Needs ReviewPublic

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

Details

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.

Event Timeline

smeenai created this revision.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.

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.

Herald added a project: Restricted Project. · View Herald TranscriptFeb 12 2019, 10:23 PM

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).