~ruther/guix-local

1a2e64956169bc943a72f17da7552b39168068b8 — Ludovic Courtès 12 years ago e1c5a83
doc: Add note about .dir-locals.el.

* HACKING (Coding Style): Mention special indentation rules and
  .dir-locals.el.
1 files changed, 8 insertions(+), 3 deletions(-)

M HACKING
M HACKING => HACKING +8 -3
@@ 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.