bug#26693: [PATCH 0/2] Fix indentation in indent-code.el and dir-locals.el

bug#26693: [PATCH 0/2] Fix indentation in indent-code.el and dir-locals.el

[Alex Kost]

As reported by Petter on #guix, "indent-code.el" may not work, and it is
absolutely not clear why it happens (it took me 20 minutes to figure out
what the problem was).

So the problem is that "indent-code.el" works only when it is run from
the top directory of the guix checkout (as it is described in the
manual), otherwise it doesn't indent properly (because it doesn't find
".dir-locals.el").

So the upcoming patch fixes this problem.  Also there is another patch
that indents 'modify-keywords' properly.

-- 
Alex

bug#26693: [PATCH 1/2] dir-locals.el: Add 'modify-phases' keywords.

[Alex Kost]

* .dir-locals.el: Add indentation rules for 'replace', 'add-before' and
'add-after'.
---
 .dir-locals.el | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.dir-locals.el b/.dir-locals.el
index a2d1eb8..4aaeae9 100644
--- a/.dir-locals.el
+++ b/.dir-locals.el
@@ -23,7 +23,13 @@
    (eval . (put 'guard 'scheme-indent-function 1))
    (eval . (put 'lambda* 'scheme-indent-function 1))
    (eval . (put 'substitute* 'scheme-indent-function 1))
+
+   ;; 'modify-phases' and its keywords.
    (eval . (put 'modify-phases 'scheme-indent-function 1))
+   (eval . (put 'replace 'scheme-indent-function 1))
+   (eval . (put 'add-before 'scheme-indent-function 2))
+   (eval . (put 'add-after 'scheme-indent-function 2))
+
    (eval . (put 'modify-services 'scheme-indent-function 1))
    (eval . (put 'with-directory-excursion 'scheme-indent-function 1))
    (eval . (put 'package 'scheme-indent-function 0))
-- 
2.10.2

bug#26693: [PATCH 2/2] doc: Add references to Emacs-Guix manual.

[Alex Kost]

* doc/htmlxref.cnf: Add links to the real manual.
* doc/contributing.texi (Formatting Code): Add reference to it.
* doc/guix.texi (Package Management): Likewise.
---
 doc/contributing.texi |  5 ++++-
 doc/guix.texi         | 12 +++++++-----
 doc/htmlxref.cnf      |  4 +++-
 3 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index bbc9342..8465745 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -248,7 +248,10 @@ please do read it.
 
 Some special forms introduced in Guix, such as the @code{substitute*}
 macro, have special indentation rules.  These are defined in the
-@file{.dir-locals.el} file, which Emacs automatically uses.
+@file{.dir-locals.el} file, which Emacs automatically uses.  Also note
+that Emacs-Guix provides @code{guix-devel-mode} mode that indents and
+highlights Guix code properly (@pxref{Development,,, emacs-guix, The
+Emacs-Guix Reference Manual}).
 
 @cindex indentation, of code
 @cindex formatting, of code
diff --git a/doc/guix.texi b/doc/guix.texi
index 0d334e3..71d39a1 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -1429,11 +1429,13 @@ remove software packages, without having to know about their build
 procedures or dependencies.  Guix also goes beyond this obvious set of
 features.
 
-This chapter describes the main features of Guix, as well as the package
-management tools it provides.  Along with the command-line interface
-described below (@pxref{Invoking guix package, @code{guix package}}),
-you may also use Emacs Interface, after installing @code{emacs-guix}
-package (run @kbd{M-x guix-help} command to start with it):
+This chapter describes the main features of Guix, as well as the
+package management tools it provides.  Along with the command-line
+interface described below (@pxref{Invoking guix package, @code{guix
+package}}), you may also use Emacs Interface (@pxref{Top,,,
+emacs-guix, The Emacs-Guix Reference Manual}), after installing
+@code{emacs-guix} package (run @kbd{M-x guix-help} command to start
+with it):
 
 @example
 guix package -i emacs-guix
diff --git a/doc/htmlxref.cnf b/doc/htmlxref.cnf
index 93e214f..78f427b 100644
--- a/doc/htmlxref.cnf
+++ b/doc/htmlxref.cnf
@@ -219,7 +219,9 @@ emacs		node	${EMACS}/html_node/emacs/
 easejs		mono	${GS}/easejs/manual/easejs.html
 easejs		node	${GS}/easejs/manual/
 
-emacs-guix	mono	https://notabug.org/alezost/emacs-guix
+EMACS_GUIX = https://alezost.github.io/guix.el/manual/latest
+emacs-guix	mono	${EMACS_GUIX}/emacs-guix.html
+emacs-guix	node	${EMACS_GUIX}/html_node/index.html
 
 emacs-muse	node	${GS}/emacs-muse/manual/muse.html
 emacs-muse	node	${GS}/emacs-muse/manual/html_node/
-- 
2.10.2

bug#26693: [PATCH 2/2] doc: Add references to Emacs-Guix manual.

[Alex Kost]

[-- Attachment #1: Type: text/plain, Size: 466 bytes --]

Alex Kost (2017-04-28 16:44 +0300) wrote:

> * doc/htmlxref.cnf: Add links to the real manual.
> * doc/contributing.texi (Formatting Code): Add reference to it.
> * doc/guix.texi (Package Management): Likewise.
> ---
>  doc/contributing.texi |  5 ++++-
>  doc/guix.texi         | 12 +++++++-----
>  doc/htmlxref.cnf      |  4 +++-
>  3 files changed, 14 insertions(+), 7 deletions(-)

I'm very sorry, this is the wrong patch :-)

The attached one is the right one.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-etc-indent-code.el-Define-source-tree-by-indent-code.patch --]
[-- Type: text/x-patch, Size: 1051 bytes --]

From d4abac119e2c62cc42a8786034c905196d7262e6 Mon Sep 17 00:00:00 2001
From: Alex Kost <alezost@gmail.com>
Date: Fri, 28 Apr 2017 16:07:33 +0300
Subject: [PATCH] etc: indent-code.el: Define source tree by "indent-code.el".

* etc/indent-code.el.in: Set default directory by "indent-code.el"
itself, otherwise it works only when called from the top directory of
the guix source tree.
---
 etc/indent-code.el.in | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/etc/indent-code.el.in b/etc/indent-code.el.in
index 68ad72c..6102b5d 100755
--- a/etc/indent-code.el.in
+++ b/etc/indent-code.el.in
@@ -26,10 +26,10 @@
 
 ;;; Code:
 
-;; Load Scheme indentation rules from the current directory.
+;; Load Scheme indentation rules from ".dir-locals.el".
 (with-temp-buffer
   (scheme-mode)
-  (let ((default-directory (file-name-as-directory "."))
+  (let ((default-directory (file-name-as-directory load-file-name))
         (enable-local-variables :all))
     (hack-dir-local-variables)
     (hack-local-variables-apply)))
-- 
2.10.2

bug#26693: [PATCH 0/2] Fix indentation in indent-code.el and dir-locals.el

[Ludovic Courtès]

Hi Alex,

Alex Kost <alezost@gmail.com> skribis:

> As reported by Petter on #guix, "indent-code.el" may not work, and it is
> absolutely not clear why it happens (it took me 20 minutes to figure out
> what the problem was).
>
> So the problem is that "indent-code.el" works only when it is run from
> the top directory of the guix checkout (as it is described in the
> manual), otherwise it doesn't indent properly (because it doesn't find
> ".dir-locals.el").
>
> So the upcoming patch fixes this problem.  Also there is another patch
> that indents 'modify-keywords' properly.

Good catch!

> * .dir-locals.el: Add indentation rules for 'replace', 'add-before' and
> 'add-after'.

OK.

> >From d4abac119e2c62cc42a8786034c905196d7262e6 Mon Sep 17 00:00:00 2001
> From: Alex Kost <alezost@gmail.com>
> Date: Fri, 28 Apr 2017 16:07:33 +0300
> Subject: [PATCH] etc: indent-code.el: Define source tree by "indent-code.el".
>
> * etc/indent-code.el.in: Set default directory by "indent-code.el"
> itself, otherwise it works only when called from the top directory of
> the guix source tree.

LGTM.

Thank you!

Ludo’.

bug#26693: [PATCH 0/2] Fix indentation in indent-code.el and dir-locals.el

[Alex Kost]

Ludovic Courtès (2017-05-02 23:39 +0200) wrote:

> Hi Alex,
>
> Alex Kost <alezost@gmail.com> skribis:
>
>> As reported by Petter on #guix, "indent-code.el" may not work, and it is
>> absolutely not clear why it happens (it took me 20 minutes to figure out
>> what the problem was).
>>
>> So the problem is that "indent-code.el" works only when it is run from
>> the top directory of the guix checkout (as it is described in the
>> manual), otherwise it doesn't indent properly (because it doesn't find
>> ".dir-locals.el").
>>
>> So the upcoming patch fixes this problem.  Also there is another patch
>> that indents 'modify-keywords' properly.
>
> Good catch!
>
>> * .dir-locals.el: Add indentation rules for 'replace', 'add-before' and
>> 'add-after'.
>
> OK.
>
>> >From d4abac119e2c62cc42a8786034c905196d7262e6 Mon Sep 17 00:00:00 2001
>> From: Alex Kost <alezost@gmail.com>
>> Date: Fri, 28 Apr 2017 16:07:33 +0300
>> Subject: [PATCH] etc: indent-code.el: Define source tree by "indent-code.el".
>>
>> * etc/indent-code.el.in: Set default directory by "indent-code.el"
>> itself, otherwise it works only when called from the top directory of
>> the guix source tree.
>
> LGTM.
>
> Thank you!

Committed, thanks!

-- 
Alex