From 1a2e64956169bc943a72f17da7552b39168068b8 Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Fri, 30 Aug 2013 23:53:13 +0200 Subject: doc: Add note about .dir-locals.el. * HACKING (Coding Style): Mention special indentation rules and .dir-locals.el. --- HACKING | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'HACKING') 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. -- cgit v1.2.3