Skip to content

Commit

Permalink
Replace the trailing markdown spaces by a backslash
Browse files Browse the repository at this point in the history
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..).
  • Loading branch information
thufschmitt committed Apr 23, 2021
1 parent 293220b commit 31313d1
Show file tree
Hide file tree
Showing 20 changed files with 260 additions and 260 deletions.
4 changes: 2 additions & 2 deletions doc/manual/src/advanced-topics/cores-vs-jobs.md
Expand Up @@ -4,13 +4,13 @@ Nix has two relevant settings with regards to how your CPU cores will
be utilized: `cores` and `max-jobs`. This chapter will talk about what
they are, how they interact, and their configuration trade-offs.

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

- `cores`
- `cores`\
Suggests how many cores each derivation should use. Similar to
`make -j`.

Expand Down
30 changes: 15 additions & 15 deletions doc/manual/src/command-ref/env-common.md
Expand Up @@ -2,11 +2,11 @@

Most Nix commands interpret the following environment variables:

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

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

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

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

- `NIX_DATA_DIR`
- `NIX_DATA_DIR`\
Overrides the location of the Nix static data directory (default
`prefix/share`).

- `NIX_LOG_DIR`
- `NIX_LOG_DIR`\
Overrides the location of the Nix log directory (default
`prefix/var/log/nix`).

- `NIX_STATE_DIR`
- `NIX_STATE_DIR`\
Overrides the location of the Nix state directory (default
`prefix/var/nix`).

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

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

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

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

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

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

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

- `GC_INITIAL_HEAP_SIZE`
- `GC_INITIAL_HEAP_SIZE`\
If Nix has been configured to use the Boehm garbage collector, this
variable sets the initial size of the heap in bytes. It defaults to
384 MiB. Setting it to a low value reduces memory consumption, but
Expand Down
6 changes: 3 additions & 3 deletions doc/manual/src/command-ref/nix-build.md
Expand Up @@ -47,16 +47,16 @@ All options not listed here are passed to `nix-store
--realise`, except for `--arg` and `--attr` / `-A` which are passed to
`nix-instantiate`.

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

- `--dry-run`
- `--dry-run`\
Show what store paths would be built or downloaded.

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

Expand Down
16 changes: 8 additions & 8 deletions doc/manual/src/command-ref/nix-channel.md
Expand Up @@ -17,26 +17,26 @@ To see the list of official NixOS channels, visit

This command has the following operations:

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

- `--remove` *name*
- `--remove` *name*\
Removes the channel named *name* from the list of subscribed
channels.

- `--list`
- `--list`\
Prints the names and URLs of all subscribed channels on standard
output.

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

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

# Files

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

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

- `nixexprs.tar.xz`
- `nixexprs.tar.xz`\
A tarball containing Nix expressions and files referenced by them
(such as build scripts and patches). At the top level, the tarball
should contain a single directory. That directory must contain a
Expand Down
14 changes: 7 additions & 7 deletions doc/manual/src/command-ref/nix-copy-closure.md
Expand Up @@ -35,21 +35,21 @@ and second to send the dump of those paths. If this bothers you, use

# Options

- `--to`
- `--to`\
Copy the closure of _paths_ from the local Nix store to the Nix
store on _machine_. This is the default.

- `--from`
- `--from`\
Copy the closure of _paths_ from the Nix store on _machine_ to the
local Nix store.

- `--gzip`
- `--gzip`\
Enable compression of the SSH connection.

- `--include-outputs`
- `--include-outputs`\
Also copy the outputs of store derivations included in the closure.

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

- `-v`
- `-v`\
Show verbose output.

# Environment variables

- `NIX_SSHOPTS`
- `NIX_SSHOPTS`\
Additional options to be passed to `ssh` on the command
line.

Expand Down

0 comments on commit 31313d1

Please sign in to comment.