aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2015-11-20 17:40:01 +0100
committerLoïc Hoguin <[email protected]>2015-11-20 17:40:01 +0100
commitbeec62e994fbf0003dd637a3b093ef65a9bbc8ff (patch)
tree72e8edb7e532fda908aea0ea486afb5d7a8d14de /doc/src/guide
parentc110f49b16ebf3cf23fbfee2f81cc6760a04dc7b (diff)
downloaderlang.mk-beec62e994fbf0003dd637a3b093ef65a9bbc8ff.tar.gz
erlang.mk-beec62e994fbf0003dd637a3b093ef65a9bbc8ff.tar.bz2
erlang.mk-beec62e994fbf0003dd637a3b093ef65a9bbc8ff.zip
Add tests and document the SP variable
People who prefer spaces instead of tabs are now covered.
Diffstat (limited to 'doc/src/guide')
-rw-r--r--doc/src/guide/getting_started.asciidoc19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/src/guide/getting_started.asciidoc b/doc/src/guide/getting_started.asciidoc
index 34280d1..71ec0cb 100644
--- a/doc/src/guide/getting_started.asciidoc
+++ b/doc/src/guide/getting_started.asciidoc
@@ -183,6 +183,25 @@ Eshell V7.0 (abort with ^G)
Simple as that!
+=== Using spaces instead of tabs
+
+Erlang.mk defaults to tabs when creating files from templates.
+This is in part because of a personal preference, and in part
+because it is much easier to convert tabs to spaces than the
+opposite.
+
+Use the `SP` variable if you prefer spaces. Set it to the number
+of spaces per indentation level you want.
+
+For example, if you prefer two spaces per indentation level:
+
+[source,bash]
+$ make -f erlang.mk bootstrap SP=2
+
+When you bootstrap the project initially, the variable automatically
+gets added to the Makefile, so you only need to provide it when
+you get started.
+
=== Using templates
It is no secret that Erlang's OTP behaviors tend to have some