picnoir/nix-gh
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

post-build-hook: docs fixup

Browse source
This commit is contained in:
Graham Christensen 2019-08-06 14:26:43 -04:00
parent 7c5596734f
commit 363a2f6826
No known key found for this signature in database
GPG key ID: ACA1C1D120C83D5C
2 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/manual/advanced-topics/post-build-hook.xml
View file

@ -74,6 +74,8 @@ trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDS
#!/bin/sh #!/bin/sh
set -eu set -eu
set -f # disable globbing
export IFS=' '
echo "Signing paths" $OUT_PATHS echo "Signing paths" $OUT_PATHS
nix sign-paths --key-file /etc/nix/key.private $OUT_PATHS nix sign-paths --key-file /etc/nix/key.private $OUT_PATHS
@ -88,8 +90,9 @@ exec nix copy --to 's3://example-nix-cache' $OUT_PATHS
list of Nix store paths. In this case, we expect and want the list of Nix store paths. In this case, we expect and want the
shell to perform word splitting to make each output path its shell to perform word splitting to make each output path its
own argument to <command>nix sign-paths</command>. Nix guarantees own argument to <command>nix sign-paths</command>. Nix guarantees
the paths will only contain characters which are safe for word the paths will not contain any spaces, however a store path
splitting, and free of any globs. might contain glob characters. The <command>set -f</command>
disables globbing in the shell.
</para> </para>
</note> </note>
<para> <para>

3
doc/manual/command-ref/conf-file.xml
View file

@ -674,6 +674,7 @@ password <replaceable>my-password</replaceable>
<listitem><para>The hook does not execute on substituted paths.</para></listitem> <listitem><para>The hook does not execute on substituted paths.</para></listitem>
<listitem><para>The hook's output always goes to the user's terminal.</para></listitem> <listitem><para>The hook's output always goes to the user's terminal.</para></listitem>
<listitem><para>If the hook fails, the build succeeds but no further builds execute.</para></listitem> <listitem><para>If the hook fails, the build succeeds but no further builds execute.</para></listitem>
<listitem><para>The hook executes synchronously, and blocks other builds from progressing while it runs.</para>
</itemizedlist> </itemizedlist>
<para>The program executes with no arguments. The program's environment <para>The program executes with no arguments. The program's environment
@ -693,7 +694,7 @@ password <replaceable>my-password</replaceable>
<varlistentry> <varlistentry>
<term><envar>OUT_PATHS</envar></term> <term><envar>OUT_PATHS</envar></term>
<listitem> <listitem>
<para>Output paths of the built derivation, separated by a space (<literal> </literal>) character.</para> <para>Output paths of the built derivation, separated by a space character.</para>
<para>Example: <para>Example:
<literal>/nix/store/zf5lbh336mnzf1nlswdn11g4n2m8zh3g-bash-4.4-p23-dev <literal>/nix/store/zf5lbh336mnzf1nlswdn11g4n2m8zh3g-bash-4.4-p23-dev
/nix/store/rjxwxwv1fpn9wa2x5ssk5phzwlcv4mna-bash-4.4-p23-doc /nix/store/rjxwxwv1fpn9wa2x5ssk5phzwlcv4mna-bash-4.4-p23-doc