aboutsummaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2013-08-30 23:53:13 +0200
committerLudovic Courtès <ludo@gnu.org>2013-08-30 23:53:13 +0200
commit1a2e64956169bc943a72f17da7552b39168068b8 (patch)
tree990ed1bd828909d9090bdf8ec918aeb24acfb0e4 /HACKING
parente1c5a8357ad1d473ecf6d12b7b4a327705c10605 (diff)
downloadguix-1a2e64956169bc943a72f17da7552b39168068b8.tar
guix-1a2e64956169bc943a72f17da7552b39168068b8.tar.gz
doc: Add note about .dir-locals.el.
* HACKING (Coding Style): Mention special indentation rules and .dir-locals.el.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING11
1 files changed, 8 insertions, 3 deletions
diff --git a/HACKING b/HACKING
index 514179227e..85e9a900be 100644
--- a/HACKING
+++ b/HACKING
@@ -115,9 +115,14 @@ In general, we follow the [[http://mumble.net/~campbell/scheme/style.txt][Riastr
to describe the conventions mostly used in Guile’s code too. It is very
thoughtful and well written, so please do read it.
-In addition, we require all top-level procedures to carry a docstring. This
-requirement can be relaxed for simple private procedures in the (guix build …)
-name space, though.
+Some special forms introduced in Guix, such as the ‘substitute*’ macro, have
+special indentation rules. These are defined in the .dir-locals.el file,
+which Emacs automatically uses. If you do not use Emacs, please make sure to
+let your editor know the rules.
+
+We require all top-level procedures to carry a docstring. This requirement
+can be relaxed for simple private procedures in the (guix build …) name space,
+though.
Procedures should not have more than four positional parameters. Use keyword
parameters for procedures that take more than four parameters.