GNU bug report logs - #30817
[PATCH] openssh-service: export AcceptEnv option

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 30817 in the body.
You can then email your comments to 30817 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Martin Castillo <castilma <at> uni-bremen.de>
To: guix-patches <at> gnu.org
Subject: [PATCH] openssh-service: export AcceptEnv option
Date: Wed, 14 Mar 2018 15:55:14 +0100

[Message part 1 (text/plain, inline)]

(Resent, because I forgot '[PATCH]' in the subject.)

This patch makes AcceptEnv configurable from config.scm.

Questions:
Is the dash in environment-variables correct?
Why are there always two spaces after a period?
Is @option the correct annotation for AcceptEnv?

Martin

[0001-services-openssh-Add-AcceptEnv-field.patch (text/x-patch, attachment)]

[signature.asc (application/pgp-signature, attachment)]

Message #8 received at 30817 <at> debbugs.gnu.org (full text, mbox):

From: ludo <at> gnu.org (Ludovic Courtès)
To: Martin Castillo <castilma <at> uni-bremen.de>
Cc: 30817 <at> debbugs.gnu.org
Subject: Re: [bug#30817] [PATCH] openssh-service: export AcceptEnv option
Date: Thu, 15 Mar 2018 18:13:37 +0100

Hello,

Martin Castillo <castilma <at> uni-bremen.de> skribis:

> This patch makes AcceptEnv configurable from config.scm.

Nice!

> Questions:
> Is the dash in environment-variables correct?

No, just “environment variables”.

> Why are there always two spaces after a period?

It’s inherited from an (old) convention honored by Emacs notably that
mimics English typographic conventions regarding spacing after
end-of-sentence periods.

> Is @option the correct annotation for AcceptEnv?

@option is normally for command-line option, so I’d just use @code.

> From e64e4a908936c5aec0c026324cc08be12edb8ec1 Mon Sep 17 00:00:00 2001
> From: Martin Castillo <castilma <at> uni-bremen.de>
> Date: Tue, 13 Mar 2018 16:40:55 +0100
> Subject: [PATCH] services: openssh: Add 'AcceptEnv' field.
>
> * gnu/services/ssh.scm (<openssh-configuration>)[AcceptEnv]: New field.
> (openssh-config-file): Honor 'AcceptEnv'.
> * doc/guix.texi (Networking Services): Document it.

Overall the patch LGTM, so the comments below are really nitpicking:

> +@item @code{accept-env} (default: @code{'()})
> +List of strings describing which environment-variables may be exported.
> +
> +Each string gets on its own line.  See the @option{AcceptEnv} option in
> +@code{sshd_config(5)}.

I’d write “… in @code{man sshd_config(5)}.”

> +@example
> +(service openssh-service-type
> +         (openssh-configuration
> +		  (accept-env '("COLORTERM"))))
> +@end example

Please add a sentence describing the example, even if it seems obvious.

> +  ;; list of strings
> +  (accept-env            openssh-configuration-accept-env
> +                         (default '()))

We usually avoid abbreviations, so that would be “accepted-environment”
(see <https://gnu.org/software/guix/manual/html_node/Formatting-Code.html>).

Could you send an updated patch?

Thanks,
Ludo’.

Message #11 received at 30817 <at> debbugs.gnu.org (full text, mbox):

From: Martin Castillo <castilma <at> uni-bremen.de>
To: Ludovic Courtès <ludo <at> gnu.org>
Cc: 30817 <at> debbugs.gnu.org
Subject: Re: [bug#30817] [PATCH] openssh-service: export AcceptEnv option
Date: Thu, 15 Mar 2018 23:54:15 +0100

[Message part 1 (text/plain, inline)]

Hello,

> Could you send an updated patch?
 Here you go

-- 
GPG: 7FDE 7190 2F73 2C50 236E  403D CC13 48F1 E644 08EC

[0001-services-openssh-Add-accepted-environment-field.patch (text/x-patch, attachment)]

[signature.asc (application/pgp-signature, attachment)]

Message #16 received at 30817-done <at> debbugs.gnu.org (full text, mbox):

From: ludo <at> gnu.org (Ludovic Courtès)
To: Martin Castillo <castilma <at> uni-bremen.de>
Cc: 30817-done <at> debbugs.gnu.org
Subject: Re: [bug#30817] [PATCH] openssh-service: export AcceptEnv option
Date: Sat, 17 Mar 2018 22:16:24 +0100

Hi Martin,

Martin Castillo <castilma <at> uni-bremen.de> skribis:

> From 2cc779c3e0f02f7f58bed4bebfac92f94353cb3b Mon Sep 17 00:00:00 2001
> From: Martin Castillo <castilma <at> uni-bremen.de>
> Date: Thu, 15 Mar 2018 23:40:58 +0100
> Subject: [PATCH] services: openssh: Add 'accepted-environment' field.
>
> * gnu/services/ssh.scm (<openssh-configuration>)[accepted-environment]: New field.
> (openssh-config-file): Honor 'acccepted-environment'.
> * doc/guix.texi (Networking Services): Document it.

Awesome.  Applied, thanks!

Ludo’.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.