diff options
| -rw-r--r-- | docs/markdown/FAQ.md | 9 | ||||
| -rw-r--r-- | docs/markdown/Using-multiple-build-directories.md | 6 |
2 files changed, 13 insertions, 2 deletions
diff --git a/docs/markdown/FAQ.md b/docs/markdown/FAQ.md index 1894f27..d3e3d0a 100644 --- a/docs/markdown/FAQ.md +++ b/docs/markdown/FAQ.md @@ -683,3 +683,12 @@ executable( link_language : 'c', ) ``` + +## How do I ignore the build directory in my VCS? + +You don't need to, assuming you use git or mercurial! Meson >=0.57.0 will +create a `.gitignore` and `.hgignore` file for you, inside each build +directory. It glob ignores ```"*"```, since all generated files should not be +checked into git. + +Users of older versions of Meson may need to set up ignore files themselves. diff --git a/docs/markdown/Using-multiple-build-directories.md b/docs/markdown/Using-multiple-build-directories.md index 2e6fa74..5086dda 100644 --- a/docs/markdown/Using-multiple-build-directories.md +++ b/docs/markdown/Using-multiple-build-directories.md @@ -6,12 +6,14 @@ are placed in a separate subdirectory. This goes against common Unix tradition where you build your projects in-source. Building out of source gives two major advantages. -First of all this makes for very simple `.gitignore` files. In +First of all this makes for very simple VCS "ignore" files. In classical build systems you may need to have tens of lines of definitions, most of which contain wildcards. When doing out of source builds all of this busywork goes away. A common ignore file for a Meson project only contains a few lines that are the build directory -and IDE project files. +and IDE project files. (Note that since Meson 0.57.0, build directories +are automatically ignored for git and mercurial by generating an ignore +file inside the build directory.) Secondly this makes it very easy to clean your projects: just delete the build subdirectory and you are done. There is no need to guess |