diff mbox

Patch to rename NIX_CONF_DIR to GUIX_CONF_DIR

Message ID CAL1_immtFeqaiwq_xYFLLJ3T1wXjtUmOcD=aAJW5XEbyMp6e8A@mail.gmail.com
State New
Headers show

Commit Message

David Craven June 23, 2016, 7:07 p.m. UTC
Hi

First I have to say `guix build guix --with-source=.` is totally awesome!!

I couldn't find any documentation on the git commit message
convention, hope I did it right.

Thanks
David

Comments

non such June 23, 2016, 10:44 p.m. UTC | #1
On 2016-06-23(09:07:49PM+0200), David Craven wrote:
> Hi
>
> First I have to say `guix build guix --with-source=.` is totally awesome!!
>
> I couldn't find any documentation on the git commit message
> convention, hope I did it right.

Thanks for the patch.
As far as I know we follow the GNU coding style,
and it should even be linked in the contributing
part of the manual.. if it's not obvious, Feedback
is welcome.

https://www.gnu.org/software/guix/manual/html_node/Submitting-Patches.html#Submitting-Patches

> Thanks
> David

> From d6acb7f685d2d3a5e51c2601e8a48c2fee54c1cd Mon Sep 17 00:00:00 2001
> From: David Craven <david@craven.ch>
> Date: Thu, 23 Jun 2016 19:44:38 +0200
> Subject: [PATCH] guix: Rename NIX_CONF_DIR to GUIX_CONF_DIR.
>
> A search/replace for compatibility with nix.
>
> * build-aux/test-env.in
> * gnu/packages/patches/hydra-automake-1.15.patch
> * guix/config.scm.in
> * nix/libstore/globals.cc
> * nix/local.mk
> ---
>  build-aux/test-env.in                          | 12 ++++++------
>  gnu/packages/patches/hydra-automake-1.15.patch |  4 ++--
>  guix/config.scm.in                             |  4 ++--
>  nix/libstore/globals.cc                        |  2 +-
>  nix/local.mk                                   |  2 +-
>  5 files changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/build-aux/test-env.in b/build-aux/test-env.in
> index c153763..b31752d 100644
> --- a/build-aux/test-env.in
> +++ b/build-aux/test-env.in
> @@ -69,16 +69,16 @@ then
>      fi
>
>      # The configuration directory, for import/export signing keys.
> -    NIX_CONF_DIR="@GUIX_TEST_ROOT@/etc"
> -    if [ ! -d "$NIX_CONF_DIR" ]
> +    GUIX_CONF_DIR="@GUIX_TEST_ROOT@/etc"
> +    if [ ! -d "$GUIX_CONF_DIR" ]
>      then
>  	# Copy the keys so that the secret key has the right permissions (the
>  	# daemon errors out when this is not the case.)
> -	mkdir -p "$NIX_CONF_DIR"
> +	mkdir -p "$GUIX_CONF_DIR"
>  	cp "@abs_top_srcdir@/tests/signing-key.sec"	\
>  	    "@abs_top_srcdir@/tests/signing-key.pub"	\
> -	    "$NIX_CONF_DIR"
> -	chmod 400 "$NIX_CONF_DIR/signing-key.sec"
> +	    "$GUIX_CONF_DIR"
> +	chmod 400 "$GUIX_CONF_DIR/signing-key.sec"
>      fi
>
>      # A place to store data of the substituter.
> @@ -100,7 +100,7 @@ then
>  	NIX_LOCALSTATE_DIR NIX_LOG_DIR NIX_STATE_DIR NIX_DB_DIR	\
>  	NIX_ROOT_FINDER GUIX_BINARY_SUBSTITUTE_URL		\
>          GUIX_ALLOW_UNAUTHENTICATED_SUBSTITUTES			\
> -        NIX_CONF_DIR XDG_CACHE_HOME NIXPKGS
> +        GUIX_CONF_DIR XDG_CACHE_HOME NIXPKGS
>
>      # Launch the daemon without chroot support because is may be
>      # unavailable, for instance if we're not running as root.
> diff --git a/gnu/packages/patches/hydra-automake-1.15.patch b/gnu/packages/patches/hydra-automake-1.15.patch
> index 0d8fa98..b79aad8 100644
> --- a/gnu/packages/patches/hydra-automake-1.15.patch
> +++ b/gnu/packages/patches/hydra-automake-1.15.patch
> @@ -23,7 +23,7 @@ Automake's parallel test harness.
>  -  HYDRA_HOME="$(top_srcdir)/src"			\
>  -  HYDRA_CONFIG=						\
>  -  NIX_REMOTE=						\
> --  NIX_CONF_DIR="$(abs_builddir)/nix/etc/nix"		\
> +-  GUIX_CONF_DIR="$(abs_builddir)/nix/etc/nix"		\
>  -  NIX_STATE_DIR="$(abs_builddir)/nix/var/nix"		\
>  -  NIX_MANIFESTS_DIR="$(abs_builddir)/nix/var/nix/manifests"	\
>  -  NIX_STORE_DIR="$(abs_builddir)/nix/store"			\
> @@ -39,7 +39,7 @@ Automake's parallel test harness.
>  +  HYDRA_HOME="$(top_srcdir)/src"; export HYDRA_HOME;	\
>  +  HYDRA_CONFIG=; export HYDRA_CONFIG;			\
>  +  NIX_REMOTE=; export NIX_REMOTE;			\
> -+  NIX_CONF_DIR="$(abs_builddir)/nix/etc/nix"; export NIX_CONF_DIR; \
> ++  GUIX_CONF_DIR="$(abs_builddir)/nix/etc/nix"; export GUIX_CONF_DIR; \
>  +  NIX_STATE_DIR="$(abs_builddir)/nix/var/nix"; export NIX_STATE_DIR; \
>  +  NIX_MANIFESTS_DIR="$(abs_builddir)/nix/var/nix/manifests"; export NIX_MANIFESTS_DIR; \
>  +  NIX_STORE_DIR="$(abs_builddir)/nix/store"; export NIX_STORE_DIR; \
> diff --git a/guix/config.scm.in b/guix/config.scm.in
> index d7df9f7..82886b4 100644
> --- a/guix/config.scm.in
> +++ b/guix/config.scm.in
> @@ -59,8 +59,8 @@
>    (or (getenv "NIX_STATE_DIR") "@guix_localstatedir@/guix"))
>
>  (define %config-directory
> -  ;; This must match `NIX_CONF_DIR' as defined in `nix/local.mk'.
> -  (or (getenv "NIX_CONF_DIR") "@guix_sysconfdir@/guix"))
> +  ;; This must match `GUIX_CONF_DIR' as defined in `nix/local.mk'.
> +  (or (getenv "GUIX_CONF_DIR") "@guix_sysconfdir@/guix"))
>
>  (define %guix-register-program
>    ;; The 'guix-register' program.
> diff --git a/nix/libstore/globals.cc b/nix/libstore/globals.cc
> index 84fc885..412073c 100644
> --- a/nix/libstore/globals.cc
> +++ b/nix/libstore/globals.cc
> @@ -67,7 +67,7 @@ void Settings::processEnvironment()
>      nixLogDir = canonPath(getEnv("NIX_LOG_DIR", NIX_LOG_DIR));
>      nixStateDir = canonPath(getEnv("NIX_STATE_DIR", NIX_STATE_DIR));
>      nixDBPath = getEnv("NIX_DB_DIR", nixStateDir + "/db");
> -    nixConfDir = canonPath(getEnv("NIX_CONF_DIR", NIX_CONF_DIR));
> +    nixConfDir = canonPath(getEnv("GUIX_CONF_DIR", GUIX_CONF_DIR));
>      nixLibexecDir = canonPath(getEnv("NIX_LIBEXEC_DIR", NIX_LIBEXEC_DIR));
>      nixBinDir = canonPath(getEnv("NIX_BIN_DIR", NIX_BIN_DIR));
>      nixDaemonSocketFile = canonPath(nixStateDir + DEFAULT_SOCKET_PATH);
> diff --git a/nix/local.mk b/nix/local.mk
> index 07a92f7..7bf40fa 100644
> --- a/nix/local.mk
> +++ b/nix/local.mk
> @@ -106,7 +106,7 @@ libstore_a_CPPFLAGS =				\
>    -DNIX_DATA_DIR=\"$(datadir)\"			\
>    -DNIX_STATE_DIR=\"$(localstatedir)/guix\"	\
>    -DNIX_LOG_DIR=\"$(localstatedir)/log/guix\"	\
> -  -DNIX_CONF_DIR=\"$(sysconfdir)/guix\"		\
> +  -DGUIX_CONF_DIR=\"$(sysconfdir)/guix\"		\
>    -DNIX_LIBEXEC_DIR=\"$(libexecdir)\"		\
>    -DNIX_BIN_DIR=\"$(bindir)\"			\
>    -DOPENSSL_PATH="\"guix-authenticate\""	\
> --
> 2.8.3
>


--
♥Ⓐ ng0
For non-prism friendly talk find me on
psyced.org / loupsycedyglgamf.onion
Ludovic Courtès June 24, 2016, 12:21 p.m. UTC | #2
Hello!

David Craven <david@craven.ch> skribis:

> First I have to say `guix build guix --with-source=.` is totally awesome!!

Thanks!  Don’t miss --with-input too!  ;-)

  https://www.gnu.org/software/guix/manual/html_node/Package-Transformation-Options.html

> I couldn't find any documentation on the git commit message
> convention, hope I did it right.

ng0 already replied on that point; you’re almost there.  :-)

The patch omits to change references to ‘NIX_CONF_DIR’ in the *.cc and
*.h files under nix/.  Could you update it accordingly?

While at it, can you make it ‘GUIX_CONFIGURATION_DIRECTORY’ instead of
‘GUIX_CONF_DIR’ (following the Scheme tradition of avoiding
abbreviations ;-))?

Last, please run the test suite to make sure nothing goes wrong:

  https://www.gnu.org/software/guix/manual/html_node/Running-the-Test-Suite.html

Thank you for looking into it!

Ludo’.
David Craven June 24, 2016, 3:02 p.m. UTC | #3
Did you have a test failure? I get one on `tests/substitute.scm`.

After `sudo guix archive --generate-key` I still get a test failure,
but `sudo make check TESTS="tests/substitute.scm"` remedied it.

Who's supposed to own the keys? A private key in /etc shouldn't be
owned by anyone other than root should it?

But I don't think this has anything to do with my patch so I don't know
why you'd get this failure.


I don't think I missed any references, quoting ng0:

>  nix/libstore/globals.cc                    |  2 +-
>  nix/local.mk                                   |  2 +-

Are there any other references? That would be a serious bug in my text
editor ;-)

On Fri, Jun 24, 2016 at 2:21 PM, Ludovic Courtès <ludo@gnu.org> wrote:
> Hello!
>
> David Craven <david@craven.ch> skribis:
>
>> First I have to say `guix build guix --with-source=.` is totally awesome!!
>
> Thanks!  Don’t miss --with-input too!  ;-)
>
>   https://www.gnu.org/software/guix/manual/html_node/Package-Transformation-Options.html
>
>> I couldn't find any documentation on the git commit message
>> convention, hope I did it right.
>
> ng0 already replied on that point; you’re almost there.  :-)
>
> The patch omits to change references to ‘NIX_CONF_DIR’ in the *.cc and
> *.h files under nix/.  Could you update it accordingly?
>
> While at it, can you make it ‘GUIX_CONFIGURATION_DIRECTORY’ instead of
> ‘GUIX_CONF_DIR’ (following the Scheme tradition of avoiding
> abbreviations ;-))?
>
> Last, please run the test suite to make sure nothing goes wrong:
>
>   https://www.gnu.org/software/guix/manual/html_node/Running-the-Test-Suite.html
>
> Thank you for looking into it!
>
> Ludo’.
diff mbox

Patch

From d6acb7f685d2d3a5e51c2601e8a48c2fee54c1cd Mon Sep 17 00:00:00 2001
From: David Craven <david@craven.ch>
Date: Thu, 23 Jun 2016 19:44:38 +0200
Subject: [PATCH] guix: Rename NIX_CONF_DIR to GUIX_CONF_DIR.

A search/replace for compatibility with nix.

* build-aux/test-env.in
* gnu/packages/patches/hydra-automake-1.15.patch
* guix/config.scm.in
* nix/libstore/globals.cc
* nix/local.mk
---
 build-aux/test-env.in                          | 12 ++++++------
 gnu/packages/patches/hydra-automake-1.15.patch |  4 ++--
 guix/config.scm.in                             |  4 ++--
 nix/libstore/globals.cc                        |  2 +-
 nix/local.mk                                   |  2 +-
 5 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/build-aux/test-env.in b/build-aux/test-env.in
index c153763..b31752d 100644
--- a/build-aux/test-env.in
+++ b/build-aux/test-env.in
@@ -69,16 +69,16 @@  then
     fi
 
     # The configuration directory, for import/export signing keys.
-    NIX_CONF_DIR="@GUIX_TEST_ROOT@/etc"
-    if [ ! -d "$NIX_CONF_DIR" ]
+    GUIX_CONF_DIR="@GUIX_TEST_ROOT@/etc"
+    if [ ! -d "$GUIX_CONF_DIR" ]
     then
 	# Copy the keys so that the secret key has the right permissions (the
 	# daemon errors out when this is not the case.)
-	mkdir -p "$NIX_CONF_DIR"
+	mkdir -p "$GUIX_CONF_DIR"
 	cp "@abs_top_srcdir@/tests/signing-key.sec"	\
 	    "@abs_top_srcdir@/tests/signing-key.pub"	\
-	    "$NIX_CONF_DIR"
-	chmod 400 "$NIX_CONF_DIR/signing-key.sec"
+	    "$GUIX_CONF_DIR"
+	chmod 400 "$GUIX_CONF_DIR/signing-key.sec"
     fi
 
     # A place to store data of the substituter.
@@ -100,7 +100,7 @@  then
 	NIX_LOCALSTATE_DIR NIX_LOG_DIR NIX_STATE_DIR NIX_DB_DIR	\
 	NIX_ROOT_FINDER GUIX_BINARY_SUBSTITUTE_URL		\
         GUIX_ALLOW_UNAUTHENTICATED_SUBSTITUTES			\
-        NIX_CONF_DIR XDG_CACHE_HOME NIXPKGS
+        GUIX_CONF_DIR XDG_CACHE_HOME NIXPKGS
 
     # Launch the daemon without chroot support because is may be
     # unavailable, for instance if we're not running as root.
diff --git a/gnu/packages/patches/hydra-automake-1.15.patch b/gnu/packages/patches/hydra-automake-1.15.patch
index 0d8fa98..b79aad8 100644
--- a/gnu/packages/patches/hydra-automake-1.15.patch
+++ b/gnu/packages/patches/hydra-automake-1.15.patch
@@ -23,7 +23,7 @@  Automake's parallel test harness.
 -  HYDRA_HOME="$(top_srcdir)/src"			\
 -  HYDRA_CONFIG=						\
 -  NIX_REMOTE=						\
--  NIX_CONF_DIR="$(abs_builddir)/nix/etc/nix"		\
+-  GUIX_CONF_DIR="$(abs_builddir)/nix/etc/nix"		\
 -  NIX_STATE_DIR="$(abs_builddir)/nix/var/nix"		\
 -  NIX_MANIFESTS_DIR="$(abs_builddir)/nix/var/nix/manifests"	\
 -  NIX_STORE_DIR="$(abs_builddir)/nix/store"			\
@@ -39,7 +39,7 @@  Automake's parallel test harness.
 +  HYDRA_HOME="$(top_srcdir)/src"; export HYDRA_HOME;	\
 +  HYDRA_CONFIG=; export HYDRA_CONFIG;			\
 +  NIX_REMOTE=; export NIX_REMOTE;			\
-+  NIX_CONF_DIR="$(abs_builddir)/nix/etc/nix"; export NIX_CONF_DIR; \
++  GUIX_CONF_DIR="$(abs_builddir)/nix/etc/nix"; export GUIX_CONF_DIR; \
 +  NIX_STATE_DIR="$(abs_builddir)/nix/var/nix"; export NIX_STATE_DIR; \
 +  NIX_MANIFESTS_DIR="$(abs_builddir)/nix/var/nix/manifests"; export NIX_MANIFESTS_DIR; \
 +  NIX_STORE_DIR="$(abs_builddir)/nix/store"; export NIX_STORE_DIR; \
diff --git a/guix/config.scm.in b/guix/config.scm.in
index d7df9f7..82886b4 100644
--- a/guix/config.scm.in
+++ b/guix/config.scm.in
@@ -59,8 +59,8 @@ 
   (or (getenv "NIX_STATE_DIR") "@guix_localstatedir@/guix"))
 
 (define %config-directory
-  ;; This must match `NIX_CONF_DIR' as defined in `nix/local.mk'.
-  (or (getenv "NIX_CONF_DIR") "@guix_sysconfdir@/guix"))
+  ;; This must match `GUIX_CONF_DIR' as defined in `nix/local.mk'.
+  (or (getenv "GUIX_CONF_DIR") "@guix_sysconfdir@/guix"))
 
 (define %guix-register-program
   ;; The 'guix-register' program.
diff --git a/nix/libstore/globals.cc b/nix/libstore/globals.cc
index 84fc885..412073c 100644
--- a/nix/libstore/globals.cc
+++ b/nix/libstore/globals.cc
@@ -67,7 +67,7 @@  void Settings::processEnvironment()
     nixLogDir = canonPath(getEnv("NIX_LOG_DIR", NIX_LOG_DIR));
     nixStateDir = canonPath(getEnv("NIX_STATE_DIR", NIX_STATE_DIR));
     nixDBPath = getEnv("NIX_DB_DIR", nixStateDir + "/db");
-    nixConfDir = canonPath(getEnv("NIX_CONF_DIR", NIX_CONF_DIR));
+    nixConfDir = canonPath(getEnv("GUIX_CONF_DIR", GUIX_CONF_DIR));
     nixLibexecDir = canonPath(getEnv("NIX_LIBEXEC_DIR", NIX_LIBEXEC_DIR));
     nixBinDir = canonPath(getEnv("NIX_BIN_DIR", NIX_BIN_DIR));
     nixDaemonSocketFile = canonPath(nixStateDir + DEFAULT_SOCKET_PATH);
diff --git a/nix/local.mk b/nix/local.mk
index 07a92f7..7bf40fa 100644
--- a/nix/local.mk
+++ b/nix/local.mk
@@ -106,7 +106,7 @@  libstore_a_CPPFLAGS =				\
   -DNIX_DATA_DIR=\"$(datadir)\"			\
   -DNIX_STATE_DIR=\"$(localstatedir)/guix\"	\
   -DNIX_LOG_DIR=\"$(localstatedir)/log/guix\"	\
-  -DNIX_CONF_DIR=\"$(sysconfdir)/guix\"		\
+  -DGUIX_CONF_DIR=\"$(sysconfdir)/guix\"		\
   -DNIX_LIBEXEC_DIR=\"$(libexecdir)\"		\
   -DNIX_BIN_DIR=\"$(bindir)\"			\
   -DOPENSSL_PATH="\"guix-authenticate\""	\
-- 
2.8.3