Re: [PATCH] emacs: Add 'pretty-sha-path'.

[ludo@gnu.org (Ludovic Courtès)]

Alex Kost <alezost@gmail.com> skribis:

> Also I forgot to mention “emacs/guix-messages.el” in “emacs.am” in
> commit 62f261d, so I did it in this patch (I hope it's not too evil :-))

Maybe “evil” is too strong a word ;-), but please keep the
emacs/guix-messages.el addition in a separate commit.

Commits are cheap and easy, so let’s favor clarity.

> From e7ca6550d7f33d894e0023e3305938fce365fdba Mon Sep 17 00:00:00 2001
> From: Alex Kost <alezost@gmail.com>
> Date: Tue, 4 Nov 2014 19:38:27 +0300
> Subject: [PATCH] emacs: Add 'pretty-sha-path'.
>
> * emacs/pretty-sha-path.el: New file.
> * emacs.am (ELFILES): Add it.
> * doc/emacs.texi (Emacs Pretty Path): New node.

[...]

> +@node Emacs Pretty Path
> +@subsection Pretty SHA Path Mode

What about adding, at the end of the first paragraph of the “Features”
section, something like:

  ... where @code{xxx} is a base32 string (note that Guix comes with an
  Emacs extension to shorten those file names, @ref{Emacs Pretty Path}.)

> +Along with ``guix.el'', GNU@tie{}Guix comes with ``pretty-sha-path.el''.
> +It provides a minor mode for abbreviating store paths by replacing
> +SHA-sequences of symbols with ``@dots{}'':
> +
> +@example
> +/gnu/store/onecansee32lettersandnumbershere-foo-0.1  @result{}  /gnu/store/…-foo-0.1

Perhaps insert a line break before @result{}, otherwise the PDF output
may be truncated.

> +@item M-x pretty-sha-path-global-mode
> +Enable/disable prettifying globally.

It seemed to me that the convention would be to call it
global-pretty-sha-path-mode rather, no?

Other than that, LGTM!

Mark is right about refining the regexp, but OTOH false positives are
very unlikely, and it might make things slightly slower, no?  So either
way is fine with me.

Thanks!

Ludo’.