Skip to content

Commit 31313d1

Browse files
thufschmittthufschmitt
committedApr 23, 2021
Replace the trailing markdown spaces by a backslash
They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
·
2.28.22.4pre-rc1
1 parent 293220b commit 31313d1

20 files changed

+260
-260
lines changed
 

Diff for: ‎doc/manual/src/advanced-topics/cores-vs-jobs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ Nix has two relevant settings with regards to how your CPU cores will
44
be utilized: `cores` and `max-jobs`. This chapter will talk about what
55
they are, how they interact, and their configuration trade-offs.
66

7-
- `max-jobs`
7+
- `max-jobs`\
88
Dictates how many separate derivations will be built at the same
99
time. If you set this to zero, the local machine will do no
1010
builds. Nix will still substitute from binary caches, and build
1111
remotely if remote builders are configured.
1212

13-
- `cores`
13+
- `cores`\
1414
Suggests how many cores each derivation should use. Similar to
1515
`make -j`.
1616

Diff for: ‎doc/manual/src/command-ref/env-common.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
Most Nix commands interpret the following environment variables:
44

5-
- `IN_NIX_SHELL`
5+
- `IN_NIX_SHELL`\
66
Indicator that tells if the current environment was set up by
77
`nix-shell`. Since Nix 2.0 the values are `"pure"` and `"impure"`
88

9-
- `NIX_PATH`
9+
- `NIX_PATH`\
1010
A colon-separated list of directories used to look up Nix
1111
expressions enclosed in angle brackets (i.e., `<path>`). For
1212
instance, the value
@@ -40,7 +40,7 @@ Most Nix commands interpret the following environment variables:
4040
The search path can be extended using the `-I` option, which takes
4141
precedence over `NIX_PATH`.
4242

43-
- `NIX_IGNORE_SYMLINK_STORE`
43+
- `NIX_IGNORE_SYMLINK_STORE`\
4444
Normally, the Nix store directory (typically `/nix/store`) is not
4545
allowed to contain any symlink components. This is to prevent
4646
“impure” builds. Builders sometimes “canonicalise” paths by
@@ -62,58 +62,58 @@ Most Nix commands interpret the following environment variables:
6262
6363
Consult the mount 8 manual page for details.
6464

65-
- `NIX_STORE_DIR`
65+
- `NIX_STORE_DIR`\
6666
Overrides the location of the Nix store (default `prefix/store`).
6767

68-
- `NIX_DATA_DIR`
68+
- `NIX_DATA_DIR`\
6969
Overrides the location of the Nix static data directory (default
7070
`prefix/share`).
7171

72-
- `NIX_LOG_DIR`
72+
- `NIX_LOG_DIR`\
7373
Overrides the location of the Nix log directory (default
7474
`prefix/var/log/nix`).
7575

76-
- `NIX_STATE_DIR`
76+
- `NIX_STATE_DIR`\
7777
Overrides the location of the Nix state directory (default
7878
`prefix/var/nix`).
7979

80-
- `NIX_CONF_DIR`
80+
- `NIX_CONF_DIR`\
8181
Overrides the location of the system Nix configuration directory
8282
(default `prefix/etc/nix`).
8383

84-
- `NIX_CONFIG`
84+
- `NIX_CONFIG`\
8585
Applies settings from Nix configuration from the environment.
8686
The content is treated as if it was read from a Nix configuration file.
8787
Settings are separated by the newline character.
8888

89-
- `NIX_USER_CONF_FILES`
89+
- `NIX_USER_CONF_FILES`\
9090
Overrides the location of the user Nix configuration files to load
9191
from (defaults to the XDG spec locations). The variable is treated
9292
as a list separated by the `:` token.
9393

94-
- `TMPDIR`
94+
- `TMPDIR`\
9595
Use the specified directory to store temporary files. In particular,
9696
this includes temporary build directories; these can take up
9797
substantial amounts of disk space. The default is `/tmp`.
9898

99-
- `NIX_REMOTE`
99+
- `NIX_REMOTE`\
100100
This variable should be set to `daemon` if you want to use the Nix
101101
daemon to execute Nix operations. This is necessary in [multi-user
102102
Nix installations](../installation/multi-user.md). If the Nix
103103
daemon's Unix socket is at some non-standard path, this variable
104104
should be set to `unix://path/to/socket`. Otherwise, it should be
105105
left unset.
106106

107-
- `NIX_SHOW_STATS`
107+
- `NIX_SHOW_STATS`\
108108
If set to `1`, Nix will print some evaluation statistics, such as
109109
the number of values allocated.
110110

111-
- `NIX_COUNT_CALLS`
111+
- `NIX_COUNT_CALLS`\
112112
If set to `1`, Nix will print how often functions were called during
113113
Nix expression evaluation. This is useful for profiling your Nix
114114
expressions.
115115

116-
- `GC_INITIAL_HEAP_SIZE`
116+
- `GC_INITIAL_HEAP_SIZE`\
117117
If Nix has been configured to use the Boehm garbage collector, this
118118
variable sets the initial size of the heap in bytes. It defaults to
119119
384 MiB. Setting it to a low value reduces memory consumption, but

Diff for: ‎doc/manual/src/command-ref/nix-build.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,16 @@ All options not listed here are passed to `nix-store
4747
--realise`, except for `--arg` and `--attr` / `-A` which are passed to
4848
`nix-instantiate`.
4949

50-
- `--no-out-link`
50+
- `--no-out-link`\
5151
Do not create a symlink to the output path. Note that as a result
5252
the output does not become a root of the garbage collector, and so
5353
might be deleted by `nix-store
5454
--gc`.
5555

56-
- `--dry-run`
56+
- `--dry-run`\
5757
Show what store paths would be built or downloaded.
5858

59-
- `--out-link` / `-o` *outlink*
59+
- `--out-link` / `-o` *outlink*\
6060
Change the name of the symlink to the output path created from
6161
`result` to *outlink*.
6262

Diff for: ‎doc/manual/src/command-ref/nix-channel.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,26 @@ To see the list of official NixOS channels, visit
1717

1818
This command has the following operations:
1919

20-
- `--add` *url* \[*name*\]
20+
- `--add` *url* \[*name*\]\
2121
Adds a channel named *name* with URL *url* to the list of subscribed
2222
channels. If *name* is omitted, it defaults to the last component of
2323
*url*, with the suffixes `-stable` or `-unstable` removed.
2424

25-
- `--remove` *name*
25+
- `--remove` *name*\
2626
Removes the channel named *name* from the list of subscribed
2727
channels.
2828

29-
- `--list`
29+
- `--list`\
3030
Prints the names and URLs of all subscribed channels on standard
3131
output.
3232

33-
- `--update` \[*names*…\]
33+
- `--update` \[*names*…\]\
3434
Downloads the Nix expressions of all subscribed channels (or only
3535
those included in *names* if specified) and makes them the default
3636
for `nix-env` operations (by symlinking them from the directory
3737
`~/.nix-defexpr`).
3838

39-
- `--rollback` \[*generation*\]
39+
- `--rollback` \[*generation*\]\
4040
Reverts the previous call to `nix-channel
4141
--update`. Optionally, you can specify a specific channel generation
4242
number to restore.
@@ -70,14 +70,14 @@ $ nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'
7070

7171
# Files
7272

73-
- `/nix/var/nix/profiles/per-user/username/channels`
73+
- `/nix/var/nix/profiles/per-user/username/channels`\
7474
`nix-channel` uses a `nix-env` profile to keep track of previous
7575
versions of the subscribed channels. Every time you run `nix-channel
7676
--update`, a new channel generation (that is, a symlink to the
7777
channel Nix expressions in the Nix store) is created. This enables
7878
`nix-channel --rollback` to revert to previous versions.
7979

80-
- `~/.nix-defexpr/channels`
80+
- `~/.nix-defexpr/channels`\
8181
This is a symlink to
8282
`/nix/var/nix/profiles/per-user/username/channels`. It ensures that
8383
`nix-env` can find your channels. In a multi-user installation, you
@@ -89,7 +89,7 @@ $ nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'
8989
A channel URL should point to a directory containing the following
9090
files:
9191

92-
- `nixexprs.tar.xz`
92+
- `nixexprs.tar.xz`\
9393
A tarball containing Nix expressions and files referenced by them
9494
(such as build scripts and patches). At the top level, the tarball
9595
should contain a single directory. That directory must contain a

Diff for: ‎doc/manual/src/command-ref/nix-copy-closure.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,21 @@ and second to send the dump of those paths. If this bothers you, use
3535

3636
# Options
3737

38-
- `--to`
38+
- `--to`\
3939
Copy the closure of _paths_ from the local Nix store to the Nix
4040
store on _machine_. This is the default.
4141

42-
- `--from`
42+
- `--from`\
4343
Copy the closure of _paths_ from the Nix store on _machine_ to the
4444
local Nix store.
4545

46-
- `--gzip`
46+
- `--gzip`\
4747
Enable compression of the SSH connection.
4848

49-
- `--include-outputs`
49+
- `--include-outputs`\
5050
Also copy the outputs of store derivations included in the closure.
5151

52-
- `--use-substitutes` / `-s`
52+
- `--use-substitutes` / `-s`\
5353
Attempt to download missing paths on the target machine using Nix’s
5454
substitute mechanism. Any paths that cannot be substituted on the
5555
target are still copied normally from the source. This is useful,
@@ -58,12 +58,12 @@ and second to send the dump of those paths. If this bothers you, use
5858
`nixos.org` (the default binary cache server) is
5959
fast.
6060

61-
- `-v`
61+
- `-v`\
6262
Show verbose output.
6363

6464
# Environment variables
6565

66-
- `NIX_SSHOPTS`
66+
- `NIX_SSHOPTS`\
6767
Additional options to be passed to `ssh` on the command
6868
line.
6969

0 commit comments

Comments
 (0)
Please sign in to comment.