aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2020-12-02Generate separate manpages for each nix subcommandEelco Dolstra
2020-12-02Adds Nix CLI Guideline to docsRok Garbas
As we are working towards Nix 3.0 we want to make sure that we make a huge step forward in Nix's user experience. And once 3.0 is out of the door we need to make sure that all future commands and features keep up the standard of user experience. This PR adds a CLI guideline document to the Nix documentation. Consider this document a good starting point and a checklist when somebody will be (re)implementing commands. Clearly this guideline does nothing to improve user experience on its own and can only be useful as long as it is going to be read and cared for. But it is a first step into that direction.
2020-11-23Fix macOS sandbox buildFabian Möller
Since c4c3c15c19bc448a4797e5d9577539cc14890618 (#4251) building Nix for macOS with sandboxing fails: ``` getting status of /nix/var/nix/profiles/per-user/root/channels/nixpkgs: Operation not permitted ``` This happens, because `EvalSettings::getDefaultNixPath` tries to access paths outside the sandbox. Since the state-dir is not required for doc generation, it is set to the dummy folder. This needs to be done for all nix invocations during doc generation, as `EvalSettings::getDefaultNixPath` is called unconditionally.
2020-11-02docs: consistent console prompt (#4213)mkenigs
Everywhere else a $ is used
2020-10-30Merge pull request #4202 from hercules-ci/nix-shell-docEelco Dolstra
Nix shell doc
2020-10-30nix-shell.md: Extend shellHook exampleRobert Hensing
2020-10-30nix-shell.md: evaluated -> runRobert Hensing
Use "run" to avoid confusion with Nix evaluation. "evaluated" was intended to reference bash eval but it's ambiguous.
2020-10-29Generalize extra-* settingsEelco Dolstra
This removes the extra-substituters and extra-sandbox-paths settings and instead makes every array setting extensible by setting "extra-<name> = <value>" in the configuration file or passing "--<name> <value>" on the command line.
2020-10-25Add sha512 to hashAlgo listings in manpages (#4186)tnias
2020-10-21Fix the docs about the new NIX_CONFIG env varJosef Kemetmüller
This was accidentally documented as NIX_OPTIONS.
2020-10-21Merge pull request #4166 from kampka/nix-conf-envEelco Dolstra
Add NIX_CONFIG env var for applying nix.conf overrides
2020-10-21Remove conf-file.xmlEelco Dolstra
This was probably revived in a bad merge.
2020-10-21Add NIX_CONFIG env var for applying nix.conf overridesChristian Kampka
2020-10-18doc: nix-shell in pure mode does *not* source user bashrcStefan Frijters
2020-10-08Remove stray 'Title:' from the manualEelco Dolstra
Closes #4096.
2020-10-02Fix macOS sandbox buildFabian Möller
2020-09-29Merge branch 'master' into access-tokensKevin Quick
2020-09-27doc/manual: update hacking docs (#4078)Maximilian Bosch
* By default, build artifacts should be installed into `outputs/` rather than `inst/`[1]. * Add instructions on how to run unit-tests. [1] 733d2e9402807e54d503c3113e854bfddb3d44e0
2020-09-24Update document generation for empty json object values.Kevin Quick
2020-09-18nix-prefetch-url: Add --executable flagBryan Richter
pkgs.fetchurl supports an executable argument, which is especially nice when downloading a large executable. This patch adds the same option to nix-prefetch-url. I have tested this to work on the simple case of prefetching a little executable: 1. nix-prefetch-url --executable https://my/little/script 2. Paste the hash into a pkgs.fetchurl-based package, script-pkg.nix 3. Delete the output from the store to avoid any misidentified artifacts 4. Realise the package script-pkg.nix 5. Run the executable I repeated the above while using --name, as well. I suspect --executable would have no meaningful effect if combined with --unpack, but I have not tried it.
2020-09-16Fix doc generationEelco Dolstra
2020-09-16jq -> nixEelco Dolstra
2020-09-12docs+test: fix remaining installer downloads without -L (#4006)Jade
Co-authored-by: lf- <lf-@users.noreply.github.com>
2020-09-07Merge #3982: Minor docs updatesVladimír Čunát
2020-09-03Remove the --indirect flagEelco Dolstra
All GC roots are now indirect.
2020-09-01hacking.md: add --prefix flag to configureCole Helbling
Otherwise, the steps advertised in this document won't actually work (e.g. `make install` will fail, trying to access /usr, and `./inst/bin/nix` won't exist).
2020-08-31Merge remote-tracking branch 'origin/master' into markdownEelco Dolstra
2020-08-30mention how to run a single functional test for faster feedback loopDomen Kožar
2020-08-28Merge branch 'minimal-logger' of https://github.com/Ma27/nixEelco Dolstra
2020-08-25Move import docsEelco Dolstra
2020-08-24Generate builtins section of the manualEelco Dolstra
2020-08-24Move primop docs inlineEelco Dolstra
This makes them available to 'nix repl'.
2020-08-24Allow primops to have Markdown documentationEelco Dolstra
2020-08-20Allow 'nix' subcommands to provide docs in Markdown formatEelco Dolstra
2020-08-20List deprecated option aliases in the docsEelco Dolstra
2020-08-19ConsistencyEelco Dolstra
2020-08-19Generate the nix.conf docs from the source codeEelco Dolstra
This means we don't have two (divergent) sets of option descriptions anymore.
2020-08-19Improve margins between sectionsEelco Dolstra
The default CSS puts almost no space between sections, but a lot of space between subsections. This flips that around.
2020-08-18Improve nix.1 manpage generatorEelco Dolstra
2020-08-17Start generation of the nix.1 manpageEelco Dolstra
2020-08-17Merge remote-tracking branch 'origin/master' into markdownEelco Dolstra
2020-08-06Add hashed-mirrors backMatthew Bauer
Some users have their own hashed-mirrors setup, that is used to mirror things in addition to what’s available on tarballs.nixos.org. Although this should be feasable to do with a Binary Cache, it’s not always easy, since you have to remember what "name" each of the tarballs has. Continuing to support hashed-mirrors is cheap, so it’s best to leave support in Nix. Note that NIX_HASHED_MIRRORS is also supported in Nixpkgs through fetchurl.nix. Note that this excludes tarballs.nixos.org from the default, as in \#3689. All of these are available on cache.nixos.org.
2020-07-31Merge remote-tracking branch 'origin/master' into markdownEelco Dolstra
2020-07-31console -> shellEelco Dolstra
2020-07-31Enable syntax highlightingEelco Dolstra
2020-07-30Merge remote-tracking branch 'origin/master' into substitute-other-storedirMatthew Bauer
2020-07-26libutil/logging: extend `internal-json` logger to make it more machine-readableMaximilian Bosch
The new error-format is pretty nice from a UX point-of-view, however it's fairly hard to parse the output e.g. for editor plugins such as vim-ale[1] that use `nix-instantiate --parse` to determine syntax errors in Nix expression files. This patch extends the `internal-json` logger by adding the fields `line`, `column` and `file` to easily locate an error in a file and the field `raw_msg` which contains the error-message itself without code-lines and additional helpers. An exemplary output may look like this: ``` [nix-shell]$ ./inst/bin/nix-instantiate ~/test.nix --log-format minimal {"action":"msg","column":1,"file":"/home/ma27/test.nix","level":0,"line":4,"raw_msg":"syntax error, unexpected IF, expecting $end","msg":"<full error-msg with code-lines etc>"} ``` [1] https://github.com/dense-analysis/ale
2020-07-24Remove DocBook manualEelco Dolstra
2020-07-24Fix internal linksEelco Dolstra
2020-07-24Fix some dangling referencesEelco Dolstra