From ce3095e14165ab0079f2c24002ae4c810b1c728d Mon Sep 17 00:00:00 2001 From: Robert Vollmert Date: Fri, 7 Jul 2017 20:38:33 +0200 Subject: [PATCH 01/10] glossary: Fix word order --- doc/manual/glossary/glossary.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/manual/glossary/glossary.xml b/doc/manual/glossary/glossary.xml index d74940c90..e0636044c 100644 --- a/doc/manual/glossary/glossary.xml +++ b/doc/manual/glossary/glossary.xml @@ -54,7 +54,7 @@ A substitute is a command invocation stored in the Nix database that describes how to build a store object, bypassing - normal the build mechanism (i.e., derivations). Typically, the + the normal build mechanism (i.e., derivations). Typically, the substitute builds the store object by downloading a pre-built version of the store object from some server. From 68c626c6b07e8676f7235c21efb94a0055f5cf3d Mon Sep 17 00:00:00 2001 From: Robert Vollmert Date: Fri, 7 Jul 2017 20:37:16 +0200 Subject: [PATCH 02/10] man pages: Grouping for option alternatives --- doc/manual/command-ref/nix-copy-closure.xml | 6 ++-- doc/manual/command-ref/opt-common-syn.xml | 32 +++++++++++++++------ 2 files changed, 28 insertions(+), 10 deletions(-) diff --git a/doc/manual/command-ref/nix-copy-closure.xml b/doc/manual/command-ref/nix-copy-closure.xml index 97e261ae9..800e1db6a 100644 --- a/doc/manual/command-ref/nix-copy-closure.xml +++ b/doc/manual/command-ref/nix-copy-closure.xml @@ -27,8 +27,10 @@ --> - - + + + + user@machine diff --git a/doc/manual/command-ref/opt-common-syn.xml b/doc/manual/command-ref/opt-common-syn.xml index 5b7936393..3aff4e1b6 100644 --- a/doc/manual/command-ref/opt-common-syn.xml +++ b/doc/manual/command-ref/opt-common-syn.xml @@ -2,10 +2,18 @@ - - - - + + + + + + + + + + + + @@ -25,10 +33,18 @@ number - - - - + + + + + + + + + + + + From d1643bdaa2f66760b5dce3e42953b433e7eb49bc Mon Sep 17 00:00:00 2001 From: Robert Vollmert Date: Fri, 7 Jul 2017 21:11:39 +0200 Subject: [PATCH 03/10] man pages: Argument for --max-jobs --- doc/manual/command-ref/opt-common.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/manual/command-ref/opt-common.xml b/doc/manual/command-ref/opt-common.xml index 2aa41c4d4..18c664d09 100644 --- a/doc/manual/command-ref/opt-common.xml +++ b/doc/manual/command-ref/opt-common.xml @@ -89,8 +89,8 @@ - - + / +number Sets the maximum number of build jobs that Nix will perform in parallel to the specified number. Specify From 56a1f8f4998cb6aa4ff2c8b61ca36634af4b3759 Mon Sep 17 00:00:00 2001 From: Robert Vollmert Date: Fri, 7 Jul 2017 21:14:45 +0200 Subject: [PATCH 04/10] man pages: Consistently separate alternatives by / --- doc/manual/command-ref/nix-env.xml | 6 ++---- doc/manual/command-ref/opt-common.xml | 12 ++++-------- 2 files changed, 6 insertions(+), 12 deletions(-) diff --git a/doc/manual/command-ref/nix-env.xml b/doc/manual/command-ref/nix-env.xml index 8462cf8a0..d4563ac47 100644 --- a/doc/manual/command-ref/nix-env.xml +++ b/doc/manual/command-ref/nix-env.xml @@ -146,8 +146,7 @@ also . - - + / path Specifies the Nix expression (designated below as the active Nix expression) used by the @@ -166,8 +165,7 @@ also . - - + / path Specifies the profile to be used by those operations that operate on a profile (designated below as the diff --git a/doc/manual/command-ref/opt-common.xml b/doc/manual/command-ref/opt-common.xml index 18c664d09..a930b4a0d 100644 --- a/doc/manual/command-ref/opt-common.xml +++ b/doc/manual/command-ref/opt-common.xml @@ -22,8 +22,7 @@ - - + / @@ -76,8 +75,7 @@ - - + / By default, output written by builders to standard output and standard error is echoed to the Nix command's standard @@ -143,8 +141,7 @@ - - + / Keep going in case of failed builds, to the greatest extent possible. That is, if building an input of some @@ -156,8 +153,7 @@ - - + / Specifies that in case of a build failure, the temporary directory (usually in /tmp) in which From b1f5995a20b5511bce614d1718816088bc7f0ec0 Mon Sep 17 00:00:00 2001 From: Robert Vollmert Date: Fri, 7 Jul 2017 20:37:55 +0200 Subject: [PATCH 05/10] man page (nix-instantiate): Remove non-existent nix-build argument -r --- doc/manual/command-ref/nix-store.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/manual/command-ref/nix-store.xml b/doc/manual/command-ref/nix-store.xml index fb017b741..19c99841a 100644 --- a/doc/manual/command-ref/nix-store.xml +++ b/doc/manual/command-ref/nix-store.xml @@ -234,7 +234,7 @@ linkend="sec-nix-build">nix-build does. To test whether a previously-built derivation is deterministic: -$ nix-build -r '<nixpkgs>' -A hello --check -K +$ nix-build '<nixpkgs>' -A hello --check -K From 8ad898b2cd2f5d7bba29da48f67658d3a04888db Mon Sep 17 00:00:00 2001 From: Robert Vollmert Date: Fri, 7 Jul 2017 21:51:22 +0200 Subject: [PATCH 06/10] man page (nix-instantiate): Add --json to synopsis, order variables --- doc/manual/command-ref/nix-instantiate.xml | 37 +++++++++++----------- 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/doc/manual/command-ref/nix-instantiate.xml b/doc/manual/command-ref/nix-instantiate.xml index fe077ff65..874228954 100644 --- a/doc/manual/command-ref/nix-instantiate.xml +++ b/doc/manual/command-ref/nix-instantiate.xml @@ -24,6 +24,7 @@ + @@ -116,24 +117,6 @@ input. - - - When used with , print the resulting - value as an XML representation of the abstract syntax tree rather than as - an ATerm. The schema is the same as that used by the toXML built-in. - - - - - - - When used with , print the resulting - value as an JSON representation of the abstract syntax tree rather - than as an ATerm. - - - When used with , @@ -148,6 +131,24 @@ input. + + + When used with , print the resulting + value as an JSON representation of the abstract syntax tree rather + than as an ATerm. + + + + + + When used with , print the resulting + value as an XML representation of the abstract syntax tree rather than as + an ATerm. The schema is the same as that used by the toXML built-in. + + + + When used with , perform From 772ef22c25f6dac969ce7f13586a08d1191f4a44 Mon Sep 17 00:00:00 2001 From: Robert Vollmert Date: Fri, 7 Jul 2017 21:51:54 +0200 Subject: [PATCH 07/10] man page (nix-instantiate): -E is optional --- doc/manual/command-ref/nix-instantiate.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/manual/command-ref/nix-instantiate.xml b/doc/manual/command-ref/nix-instantiate.xml index 874228954..39c1282fc 100644 --- a/doc/manual/command-ref/nix-instantiate.xml +++ b/doc/manual/command-ref/nix-instantiate.xml @@ -39,7 +39,7 @@ path - + From 89771a882157c22ff90ab6b1f9e93ed464aa3177 Mon Sep 17 00:00:00 2001 From: Robert Vollmert Date: Fri, 7 Jul 2017 21:52:31 +0200 Subject: [PATCH 08/10] man page (nix-prefetch-url): Add some missing options --- doc/manual/command-ref/nix-prefetch-url.xml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/manual/command-ref/nix-prefetch-url.xml b/doc/manual/command-ref/nix-prefetch-url.xml index 016d8863a..8ef748c74 100644 --- a/doc/manual/command-ref/nix-prefetch-url.xml +++ b/doc/manual/command-ref/nix-prefetch-url.xml @@ -19,14 +19,16 @@ nix-prefetch-url + hashAlgo + + name url hash - Description The command nix-prefetch-url downloads the @@ -91,7 +93,7 @@ downloaded file in the Nix store is also printed. - + name Override the name of the file in the Nix store. By default, this is From c85e662004d6f2881dde92991d3a2352e612e8e3 Mon Sep 17 00:00:00 2001 From: Robert Vollmert Date: Fri, 7 Jul 2017 21:52:56 +0200 Subject: [PATCH 09/10] man page (nix-shell): Fix grouping of -p option Not sure about the raw ellipsis. --- doc/manual/command-ref/nix-shell.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/manual/command-ref/nix-shell.xml b/doc/manual/command-ref/nix-shell.xml index c64c93ec3..078fa3849 100644 --- a/doc/manual/command-ref/nix-shell.xml +++ b/doc/manual/command-ref/nix-shell.xml @@ -33,12 +33,12 @@ regexp - - + + - packages + packages path @@ -144,7 +144,7 @@ also . - / + / packages… Set up an environment in which the specified packages are present. The command line arguments are interpreted From 30117fb35bde6ba27d7de5037272ea23c8dcebf9 Mon Sep 17 00:00:00 2001 From: Robert Vollmert Date: Mon, 10 Jul 2017 14:36:55 +0200 Subject: [PATCH 10/10] fix buggy nix-shell man page --- doc/manual/command-ref/nix-shell.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/manual/command-ref/nix-shell.xml b/doc/manual/command-ref/nix-shell.xml index 078fa3849..62d026ac2 100644 --- a/doc/manual/command-ref/nix-shell.xml +++ b/doc/manual/command-ref/nix-shell.xml @@ -39,7 +39,7 @@ packages - + path