[bug#30797] [PATCH 1/2] gnu: Add emacs-exec-path-from-shell

[bug#30797] [PATCH 1/2] gnu: Add emacs-exec-path-from-shell

[Konrad Hinsen]

* gnu/packages/emacs.scm (emacs-exec-path-from-shell): New variable.
---
 gnu/packages/emacs.scm | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/gnu/packages/emacs.scm b/gnu/packages/emacs.scm
index c2c162c75..9c9c399fd 100644
--- a/gnu/packages/emacs.scm
+++ b/gnu/packages/emacs.scm
@@ -7361,3 +7361,31 @@ highlighting and indentation support.")
 @uref{https://www.terraform.io/, Terraform} configuration files.  Most of the
 functionality is inherited from @code{hcl-mode}.")
     (license license:gpl3+)))
+
+(define-public emacs-exec-path-from-shell
+  (package
+    (name "emacs-exec-path-from-shell")
+    (version "1.11")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (string-append
+             "http://stable.melpa.org/packages/exec-path-from-shell-"
+             version
+             ".el"))
+       (sha256
+        (base32
+         "03qjgb81cq1l3j54lvlf98r75vmmgd06mj6qh5wa6mz4xzp4w26r"))))
+    (build-system emacs-build-system)
+    (home-page
+     "https://github.com/purcell/exec-path-from-shell")
+    (synopsis
+     "Get environment variables such as $PATH from the shell")
+    (description
+     "This library allows the user to set Emacs' @code{exec-path} and @code{$PATH}
+from the shell path, so that @code{shell-command}, @code{compile} and the
+like work as expected on systems on which Emacs is not guaranteed
+to inherit a login shell's environment variables.  It also allows other
+environment variables to be retrieved from the shell, so that Emacs will
+see the same values you get in a terminal.")
+    (license license:gpl3+)))
-- 
2.16.2

[bug#30797] [PATCH 1/2] gnu: Add emacs-exec-path-from-shell

[Oleg Pykhalov]

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

Hello Konrad,

Konrad Hinsen <konrad.hinsen@fastmail.net> writes:

> * gnu/packages/emacs.scm (emacs-exec-path-from-shell): New variable.
> ---
>  gnu/packages/emacs.scm | 28 ++++++++++++++++++++++++++++
>  1 file changed, 28 insertions(+)
>
> diff --git a/gnu/packages/emacs.scm b/gnu/packages/emacs.scm
> index c2c162c75..9c9c399fd 100644
> --- a/gnu/packages/emacs.scm
> +++ b/gnu/packages/emacs.scm
> @@ -7361,3 +7361,31 @@ highlighting and indentation support.")
>  @uref{https://www.terraform.io/, Terraform} configuration files.  Most of the
>  functionality is inherited from @code{hcl-mode}.")
>      (license license:gpl3+)))
> +
> +(define-public emacs-exec-path-from-shell
> +  (package
> +    (name "emacs-exec-path-from-shell")
> +    (version "1.11")
> +    (source
> +     (origin
> +       (method url-fetch)
> +       (uri (string-append
> +             "http://stable.melpa.org/packages/exec-path-from-shell-"
> +             version
> +             ".el"))

Same as in https://debbugs.gnu.org/cgi/bugreport.cgi?bug=30798#8

    Unfortunately, we can't use sources from MELPA.  The problem is:
    when a repository get a new commit, the old tarball is *REPLACED*
    with the new one on MELPA, so the package could never be built
    anymore, since the source disappeared.  That's why we use tarballs
    directly from source.

    BTW, to make a recipe more polished you could remove unnecessary new
    lines, for example:

           (uri (string-append "http://stable.melpa.org/packages/deft-"
                 version ".el"))

> +       (sha256
> +        (base32
> +         "03qjgb81cq1l3j54lvlf98r75vmmgd06mj6qh5wa6mz4xzp4w26r"))))
> +    (build-system emacs-build-system)
> +    (home-page
> +     "https://github.com/purcell/exec-path-from-shell")
> +    (synopsis 
> +     "Get environment variables such as $PATH from the shell")

Likewise (new line).

> +    (description
> +     "This library allows the user to set Emacs' @code{exec-path} and @code{$PATH}
                                                  ^
                                                  unnecessary apostrophe?

Also this line is too long (more than 80 symbols).

> +from the shell path, so that @code{shell-command}, @code{compile} and the
> +like work as expected on systems on which Emacs is not guaranteed
> +to inherit a login shell's environment variables.  It also allows other
> +environment variables to be retrieved from the shell, so that Emacs will
> +see the same values you get in a terminal.")
> +    (license license:gpl3+)))

Otherwise LGTM.

Thanks,
Oleg.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

[bug#30797] [PATCH 1/2] gnu: Add emacs-exec-path-from-shell

[Konrad Hinsen]

* gnu/packages/emacs.scm (emacs-exec-path-from-shell): New variable.
---
 gnu/packages/emacs.scm | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/gnu/packages/emacs.scm b/gnu/packages/emacs.scm
index c2c162c75..35acfdd20 100644
--- a/gnu/packages/emacs.scm
+++ b/gnu/packages/emacs.scm
@@ -7361,3 +7361,28 @@ highlighting and indentation support.")
 @uref{https://www.terraform.io/, Terraform} configuration files.  Most of the
 functionality is inherited from @code{hcl-mode}.")
     (license license:gpl3+)))
+
+(define-public emacs-exec-path-from-shell
+  (package
+    (name "emacs-exec-path-from-shell")
+    (version "1.11")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (string-append
+             "https://stable.melpa.org/packages/exec-path-from-shell-"
+             version ".el"))
+       (sha256
+        (base32
+         "03qjgb81cq1l3j54lvlf98r75vmmgd06mj6qh5wa6mz4xzp4w26r"))))
+    (build-system emacs-build-system)
+    (home-page "https://github.com/purcell/exec-path-from-shell")
+    (synopsis "Get environment variables such as $PATH from the shell")
+    (description
+     "This library allows the user to set Emacs' @code{exec-path} and
+@code{$PATH} from the shell path, so that @code{shell-command}, @code{compile}
+and the like work as expected on systems on which Emacs is not guaranteed to
+inherit a login shell's environment variables.  It also allows other
+environment variables to be retrieved from the shell, so that Emacs will see
+the same values you get in a terminal.")
+    (license license:gpl3+)))
-- 
2.16.2

bug#30797: [PATCH 1/2] gnu: Add emacs-exec-path-from-shell

[Oleg Pykhalov]

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

Hello Konrad,

Konrad Hinsen <konrad.hinsen@fastmail.net> writes:

> * gnu/packages/emacs.scm (emacs-exec-path-from-shell): New variable.
> ---
>  gnu/packages/emacs.scm | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
>
> diff --git a/gnu/packages/emacs.scm b/gnu/packages/emacs.scm
> index c2c162c75..35acfdd20 100644
> --- a/gnu/packages/emacs.scm
> +++ b/gnu/packages/emacs.scm
> @@ -7361,3 +7361,28 @@ highlighting and indentation support.")
>  @uref{https://www.terraform.io/, Terraform} configuration files.  Most of the
>  functionality is inherited from @code{hcl-mode}.")
>      (license license:gpl3+)))
> +

[…]

> +    (description
> +     "This library allows the user to set Emacs' @code{exec-path} and

I still think this apostrophe is unnecessary.  I removed it if you don't
mind.  ;-)

-     "This library allows the user to set Emacs' @code{exec-path} and
+     "This library allows the user to set Emacs @code{exec-path} and

[…]


In addition, according to Bash documentation [1] variables don't have
‘$’ in their description.

-    (synopsis "Get environment variables such as $PATH from the shell")
+    (synopsis "Get environment variables such as @var{PATH} from the shell")

- [1]  https://www.gnu.org/software/bash/manual/html_node/Bash-Variables.html


And in the description, we could use ‘@var’ instead of ‘@code’:

-This library allows the user to set Emacs @code{exec-path} and
+This library allows the user to set Emacs @var{exec-path} and

-@code{$PATH} from the shell path, so that @code{shell-command},
+@var{PATH} from the shell @var{PATH}, so that @code{shell-command},


Also don't forget a dot at end the in commit message.

    gnu: Add emacs-exec-path-from-shell.


Pushed with changes above as 22d628148ce857b620f5b8e48dc7cabe004313c5

I'll close the bug report.

Thanks,
Oleg.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

[bug#30797] [PATCH 1/2] gnu: Add emacs-exec-path-from-shell

[Konrad Hinsen]

Hi Oleg,

>> +     "This library allows the user to set Emacs' @code{exec-path} and
>
> I still think this apostrophe is unnecessary.  I removed it if you don't
> mind.  ;-)

Well, I don't mind, but according to rules of English grammar, it's
either "Emacs'" or "Emacs's'" but not simply "Emacs". See for example:

   http://www.grammar.cl/rules/genitive-case.htm

   4. Singular noun ending in –s:

   It depends…
   a. Most names: add 's (apostrophe S)

   * They had a really good time at James’s barbecue last Friday. 
   * We spent the day admiring Frances’s new car. 

   b. Classical or religious names: add ' (only the apostrophe)

   * Jesus’ disciples carried out the teachings of Jesus. 
   * Sophocles’ plays are still performed today. 


> And in the description, we could use ‘@var’ instead of ‘@code’:
>
> -This library allows the user to set Emacs @code{exec-path} and
> +This library allows the user to set Emacs @var{exec-path} and

I actually hesitated in this case, after consulting the Texinfo manual:

   7.1.7 @var{metasyntactic-variable}

   Use the @var command to indicate metasyntactic variables. A
   metasyntactic variable is something that stands for another piece of
   text. For example, you should use a metasyntactic variable in the
   documentation of a function to describe the arguments that are passed
   to that function.

   Do not use @var for the names of normal variables in computer
   programs. These are specific names, so @code is correct for them
   (@code). For example, the Emacs Lisp variable texinfo-tex-command is
   not a metasyntactic variable; it is properly formatted using @code.

I must confess I don't understand the difference between a metasyntactic
variable and a normal variable. The examples don't help: for me, a
function argument is just a pre-initialized "normal" variable.

> Pushed with changes above as 22d628148ce857b620f5b8e48dc7cabe004313c5
>
> I'll close the bug report.

Great, thanks!

Konrad.

[bug#30797] [PATCH 1/2] gnu: Add emacs-exec-path-from-shell

[Clément Lassieur]

Konrad Hinsen <konrad.hinsen@fastmail.net> writes:

> Hi Oleg,
>
>>> +     "This library allows the user to set Emacs' @code{exec-path} and
>>
>> I still think this apostrophe is unnecessary.  I removed it if you don't
>> mind.  ;-)
>
> Well, I don't mind, but according to rules of English grammar, it's
> either "Emacs'" or "Emacs's'" but not simply "Emacs". See for example:
>
>    http://www.grammar.cl/rules/genitive-case.htm
>
>    4. Singular noun ending in –s:
>
>    It depends…
>    a. Most names: add 's (apostrophe S)
>
>    * They had a really good time at James’s barbecue last Friday. 
>    * We spent the day admiring Frances’s new car. 
>
>    b. Classical or religious names: add ' (only the apostrophe)
>
>    * Jesus’ disciples carried out the teachings of Jesus. 
>    * Sophocles’ plays are still performed today. 

This has been discussed there:
https://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00649.html.

:-)

[bug#30797] [PATCH 1/2] gnu: Add emacs-exec-path-from-shell

[Konrad Hinsen]

Clément Lassieur <clement@lassieur.org> writes:

> This has been discussed there:
> https://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00649.html.
>
> :-)

Well, then... I don't expect anything else than a proclamation by Richard
Stallman can settle the question ;-)

Konrad.

[bug#30797] [PATCH 1/2] gnu: Add emacs-exec-path-from-shell

[Oleg Pykhalov]

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

Konrad Hinsen <konrad.hinsen@fastmail.net> writes:

[…]

>> And in the description, we could use ‘@var’ instead of ‘@code’:
>>
>> -This library allows the user to set Emacs @code{exec-path} and
>> +This library allows the user to set Emacs @var{exec-path} and
>
> I actually hesitated in this case, after consulting the Texinfo manual:
>
>    7.1.7 @var{metasyntactic-variable}
>
>    Use the @var command to indicate metasyntactic variables. A
>    metasyntactic variable is something that stands for another piece of
>    text. For example, you should use a metasyntactic variable in the
>    documentation of a function to describe the arguments that are passed
>    to that function.
>
>    Do not use @var for the names of normal variables in computer
>    programs. These are specific names, so @code is correct for them
>    (@code). For example, the Emacs Lisp variable texinfo-tex-command is
>    not a metasyntactic variable; it is properly formatted using @code.
>
> I must confess I don't understand the difference between a metasyntactic
> variable and a normal variable. The examples don't help: for me, a
> function argument is just a pre-initialized "normal" variable.

From Emacs source code in ‘doc/lispref/files.texi’:

    Typical values for @var{path} are @code{exec-path}
    (@pxref{Subprocess Creation}) when looking for executable programs,
    or @code{load-path} (@pxref{Library Search}) when looking for Lisp
    files.  If @var{filename} is absolute, @var{path} has no effect, but
    the suffixes in @var{suffixes} are still tried.


A proper piece of sentence according to a quote above I could think of:

   This library allows the user to set Emacs @code{exec-path} and
   @var{path} from the shell @env{PATH}

WDYT?

Thanks,
Oleg.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

[bug#30797] [PATCH 1/2] gnu: Add emacs-exec-path-from-shell

[Oleg Pykhalov]

[-- Attachment #1.1: Type: text/plain, Size: 1438 bytes --]

Konrad Hinsen <konrad.hinsen@fastmail.net> writes:

> Clément Lassieur <clement@lassieur.org> writes:
>
>> This has been discussed there:
>> https://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00649.html.
>>
>> :-)
>
> Well, then... I don't expect anything else than a proclamation by Richard
> Stallman can settle the question ;-)

Wolfgang

    On Thu, Feb 23 2012, Glenn Morris wrote:
    > A critical question. What is the standard form in GNU manuals for using
    > the possessive apostrophe with singular nouns ending in "s"?
    >
    >   This is one of Emacs's most important features.
    >
    > or
    >
    >   This is one of Emacs' most important features.

    Actually, [1] states that the latter form can be used only with
    /regular/ nouns ending in "s", but many people use the plural form
    "Emacsen", so, in current usage, "Emacs" is not a regular noun.

    [1] http://en.wikipedia.org/wiki/Saxon_genitive

RMS

    It's worse than that: "Emacs" is a plural form used as singular.
    "Emacs" originally stood for "Editing macros".


It's not clear to me what is the right form to use.


In Emacs source code repository:

$ ag -H --nobreak --nofilename "Emacs' @" | wc -l
=> 0

$ ag -H --nobreak --nofilename "Emacs's @" | wc -l
=> 9

$ ag -H --nobreak --nofilename "Emacs @" | wc -l
=> 68

So, I think we should stick to “Emacs” or “Emacs's”.


[-- Attachment #1.2: Emacs @ --]
[-- Type: text/plain, Size: 5447 bytes --]

$ ag "Emacs @"
nextstep/templates/Info-gnustep.plist.in
16:    FullVersionID = "Emacs @version@, NS Windowing";

nextstep/templates/Info.plist.in
644:	<string>Emacs @version@ @copyright@</string>

doc/man/emacs.1.in
2:.TH EMACS 1 "2007 April 13" "GNU Emacs @version@"

doc/emacs/misc.texi
2432:to another.  Once you save the Emacs @dfn{desktop}---the buffers,

doc/emacs/emacs.texi
1515:  We call Emacs @dfn{advanced} because it can do much more than simple

doc/emacs/regs.texi
9:  Emacs @dfn{registers} are compartments where you can save text,

doc/emacs/modes.texi
438:  Finally, if Emacs @emph{still} hasn't found a major mode to use, it

doc/lispref/eval.texi
71:the argument, Emacs @dfn{executes} the function (@code{car}), and if

doc/lispref/elisp.texi
247:* New Symbols::             New functions and variables in Emacs @value{EMACSVER}.

doc/lispref/display.texi
6165:the usual Emacs @code{highlight} face.

doc/lispref/nonascii.texi
746:An Emacs @dfn{character set}, or @dfn{charset}, is a set of characters

doc/misc/cl.texi
38:@center as distributed with Emacs @value{EMACSVER}

doc/misc/efaq-w32.texi
60:Emacs @value{EMACSVER}.
128:Emacs @value{EMACSVER} is known to run on all versions of Windows from

doc/misc/emacs-mime.texi
65:picture of how the Emacs @acronym{MIME} library works, and people who want
1063:The Emacs @acronym{MIME} library will respect the @code{use-hard-newlines}
1114:The Emacs @acronym{MIME} library takes a different tack.  It defines a
1861:The Emacs @acronym{MIME} library implements handling of various elements

doc/misc/viper.texi
535:These are the Emacs @samp{quit} keys.

doc/misc/reftex.texi
2937:standard Emacs @LaTeX{} mode) containing the name of the master file.  For

doc/misc/flymake.texi
198:Logging output is controlled by the Emacs @code{warning-minimum-log-level}

doc/misc/edt.texi
158:Enter the Emacs @code{customize} command.  First select the
203:for your keyboard within Emacs @strong{or} a bug in the Unix
309:@file{edt-user.el}.  The Emacs @file{etc/} directory contains an
422:Emacs @file{lisp/emulation} directory for more information.)
776:your own private lisp directory.  The Emacs @file{etc/} directory
803:A sample @file{edt-user.el} file is provided in the Emacs @file{etc/}
937:Enter the Emacs @code{customize} command.  First select the

doc/misc/cc-mode.texi
2335:An Emacs @dfn{hook} is a place to put Lisp functions that you want

doc/misc/idlwave.texi
4190:You need to make sure your Emacs @emph{load-path} contains the directory

doc/misc/eshell.texi
68:REPL for Emacs @emph{and} with an interface similar to command shells

doc/misc/calc.texi
95:GNU Emacs @value{EMACSVER}.
1600:like the regular Emacs @kbd{M-x} key except that it types the @samp{calc-}
6128:in the new definition (or use Emacs @kbd{M-w} and @kbd{C-y} commands
9848:more instructive.  This means the regular Emacs @kbd{C-h k}
10288:The standard Emacs @kbd{C-_} undo key is recognized as a synonym for @kbd{U}.
28002:again or use the regular Emacs @w{@kbd{C-x o}} (@code{other-window})
32772:it can use the actual Emacs @code{+} and related functions rather
32936:errors instead call the Emacs @code{error} function which aborts

doc/misc/gnus-coding.texi
210:@subsection Emacs @acronym{MIME}

doc/misc/ido.texi
38:@center as distributed with Emacs @value{EMACSVER}

doc/misc/efaq.texi
68:This is the version of the FAQ distributed with Emacs @value{EMACSVER}, and
216:An Emacs @dfn{command} is an @dfn{interactive} Emacs function.
873:the Emacs @samp{Help} menu, or by typing @kbd{C-h ?} (@kbd{M-x
979:Emacs @value{EMACSVER} is the current version as of this writing.  A version
1098:Consult the Emacs @file{NEWS} file (@kbd{C-h n}) for the full list of
1987:The Emacs @code{cc-mode} features an interactive procedure for

doc/misc/dired-x.texi
85:For @file{dired-x.el} as distributed with GNU Emacs @value{EMACSVER}.

doc/misc/org.texi
2061:calculations are supported using the Emacs @file{calc} package
2415:The table editor makes use of the Emacs @file{calc} package to implement
2635:A formula can be any algebraic expression understood by the Emacs @file{Calc}
13013:program or Emacs @code{create-image} and @code{image-size} API.  ImageMagick
13226:colors from the faces used by Emacs @code{font-lock} library for that source
14517:the Emacs @file{tramp} package.  Or you can publish to a local directory and

doc/misc/erc.texi
11:This manual is for ERC as distributed with Emacs @value{EMACSVER}.

doc/misc/gnus.texi
23279:command, which should feel kinda like the normal Emacs @code{undo}
30523:Gnus extends the standard Emacs @code{interactive} specification
30589:takes the same parameters as the Emacs @code{run-at-time}.  When running

doc/misc/htmlfontify.texi
511:Derives a CSS font-family specifier from an Emacs @code{:family} attribute.
539:Derive CSS border-* attributes from the Emacs @code{:box} attribute.
1042:Convert an Emacs @code{:width} attribute to a CSS font-stretch attribute.

doc/misc/woman.texi
43:@subtitle as distributed with Emacs @value{EMACSVER}
69:As distributed with Emacs @value{EMACSVER}.
123:reformatting done by the Emacs @code{man} command.  No hyphenation is
211:pages in the form of the Emacs @code{man} (or @code{manual-entry})
228:functionality of the Emacs @code{man} command, the main difference being
274:of the facilities implemented in the Emacs @code{man} library.  WoMan
580:Emacs @code{man} command (and much of the code is inherited from the

[-- Attachment #1.3: Emacs's @ --]
[-- Type: text/plain, Size: 769 bytes --]

$ ag "Emacs's @"
doc/lispintro/emacs-lisp-intro.texi
16584:code yourself; or you can use Emacs's @code{customize} feature to write
16649:others can then use Emacs's @code{customize} feature to set their
17317:that directory as part of Emacs's @code{load-path}.  Then, when Emacs

doc/emacs/text.texi
2116:  The file @file{enriched.txt} in Emacs's @code{data-directory}

doc/misc/cl.texi
3437:Emacs's @code{substring} function.  Note that @code{cl-subseq} is

doc/misc/viper.texi
683:used to delete the text previously put back by Emacs's @kbd{C-y} or by Vi's

doc/misc/eshell.texi
343:Alias to Emacs's @code{locate} function, which simply runs the external
354:Alias to Emacs's @code{occur}.

doc/misc/sc.texi
1667:in the same way that Emacs's @code{set-variable} does:

[-- Attachment #1.4: Type: text/plain, Size: 7 bytes --]


Oleg.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

[bug#30797] [PATCH 1/2] gnu: Add emacs-exec-path-from-shell

[Andreas Enge]

Hello,

an interesting bike shedding discussion!

On Fri, Mar 16, 2018 at 03:42:03PM +0100, Konrad Hinsen wrote:
> >> +     "This library allows the user to set Emacs' @code{exec-path} and

How about using the genitive with "of", "to set the @code{exec-path} of Emacs"?
I thought that "'s" was only used for people.

Or circumvent the question altogether by using a compound noun?
"to set the Emacs @code{exec-path}".

Andreas