aboutsummaryrefslogtreecommitdiff
path: root/doc/developer-notes.md
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@gmail.com>2015-10-23 12:32:40 +0200
committerWladimir J. van der Laan <laanwj@gmail.com>2015-10-23 14:24:08 +0200
commitdca7bd3152c5c21aa0a2b14aa09d4045ae51dcc5 (patch)
tree1741e84a79817c6f2d2210bf707406aec0fe8465 /doc/developer-notes.md
parent923c5e93a90a6eddde3ab8589fc393da95bbc489 (diff)
doc: Add developer notes about gitignore
- Add developer notes about `.gitignore.` - Remove qt creator specific files from gitignore, to be consistent.
Diffstat (limited to 'doc/developer-notes.md')
-rw-r--r--doc/developer-notes.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index 4189d22187..7fe292f1f8 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -171,3 +171,36 @@ Threads
- BitcoinMiner : Generates bitcoins (if wallet is enabled).
- Shutdown : Does an orderly shutdown of everything.
+
+Ignoring IDE/editor files
+--------------------------
+
+In closed-source environments in which everyone uses the same IDE it is common
+to add temporary files it produces to the project-wide `.gitignore` file.
+
+However, in open source software such as Bitcoin Core, where everyone uses
+their own editors/IDE/tools, it is less common. Only you know what files your
+editor produces and this may change from version to version. The canonical way
+to do this is thus to create your local gitignore. Add this to `~/.gitconfig`:
+
+```
+[core]
+ excludesfile = /home/.../.gitignore_global
+```
+
+(alternatively, type the command `git config --global core.excludesfile ~/.gitignore_global`
+on a terminal)
+
+Then put your favourite tool's temporary filenames in that file, e.g.
+```
+# NetBeans
+nbproject/
+```
+
+Another option is to create a per-repository excludes file `.git/info/exclude`.
+These are not committed but apply only to one repository.
+
+If a set of tools is used by the build system or scripts the repository (for
+example, lcov) it is perfectly acceptable to add its files to `.gitignore`
+and commit them.
+