aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide/getting_started.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-01-10 19:26:48 +0100
committerLoïc Hoguin <[email protected]>2016-01-10 19:26:48 +0100
commit86ddfb5491fddfd301da22eb2ccc4c201232806c (patch)
treed740967c3e02dee015f4a95c783ff99eb8363d9f /doc/src/guide/getting_started.asciidoc
parent1981748cb1c89d039470ff612b3caf9d4c48f112 (diff)
downloaderlang.mk-86ddfb5491fddfd301da22eb2ccc4c201232806c.tar.gz
erlang.mk-86ddfb5491fddfd301da22eb2ccc4c201232806c.tar.bz2
erlang.mk-86ddfb5491fddfd301da22eb2ccc4c201232806c.zip
Add a note about hiding Erlang.mk from diffs
Diffstat (limited to 'doc/src/guide/getting_started.asciidoc')
-rw-r--r--doc/src/guide/getting_started.asciidoc17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/src/guide/getting_started.asciidoc b/doc/src/guide/getting_started.asciidoc
index 04147b0..ef2f6e8 100644
--- a/doc/src/guide/getting_started.asciidoc
+++ b/doc/src/guide/getting_started.asciidoc
@@ -237,6 +237,23 @@ $ make
All that's left to do is to open it in your favorite editor
and make it do something!
+=== Hiding Erlang.mk from git
+
+Erlang.mk is a large text file. It can easily take a large part of
+a `git diff` or a `git grep` command. You can avoid this by telling
+Git that 'erlang.mk' is a binary file.
+
+Add this to your '.gitattributes' file. This is a file that you
+can create at the root of your repository:
+
+----
+erlang.mk -diff
+----
+
+The 'erlang.mk' file will still appear in diffs and greps, but
+as a binary file, meaning its contents won't be shown by default
+anymore.
+
=== Getting help
During development, if you don't remember the name of a target,