aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2021-09-01Merge pull request #5066 from Radvendii/masterEelco Dolstra
add antiquotations to paths
2021-08-31add documentation for path antiquotationsTaeer Bar-Yam
2021-08-28doc/manual/local.mk: fix 'make install DESTDIR=...'Sergei Trofimovich
Install failure is observed when we try to install into inplace location as non-root: ``` $ LANG=C make install DESTDIR=$PWD/__i__ V=1 RUST_LOG=warn mdbook build doc/manual -d /usr/share/doc/nix/manual 2021-08-28 13:29:58 [ERROR] (mdbook::utils): Error: Rendering failed 2021-08-28 13:29:58 [ERROR] (mdbook::utils): Caused By: Unexpected error when constructing destination path 2021-08-28 13:29:58 [ERROR] (mdbook::utils): Caused By: Permission denied (os error 13) make: *** [doc/manual/local.mk:98: /usr/share/doc/nix/manual/index.html] Error 101 ``` The change is to prefix paths with `$(DESTDIR)`.
2021-08-1915f4d4f Documentation follow-upPamplemousse
2021-08-05Merge pull request #5094 from Pamplemousse/simpler_docEelco Dolstra
doc/manual: don't need to copy `highlight.js` manually
2021-08-04doc/manual: don't need to copy `highlight.js` manuallyPamplemousse
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
2021-07-27Remove dead code in doc’s local.mkregnat
2021-07-27Fix the generation of nix3 manpagesregnat
- Separate the generation of the manpages from their installation - Make sure that `make` generates the manpages - Make sure that `make install` installs them Fix #5051
2021-07-19Cleanup the generation of the nix3 manpagesregnat
Use a dedicated make target for the man page rather than bundling the generation as part of `install`. Also make sure that `make install` is a fixpoint by - Removing the generated markdown files from `MANUAL_SRCS` - Not having the manpage generation write in its source directory so as to not update its timestamp (it would run each time otherwise)
2021-07-05Merge pull request #4773 from alyssais/dlEelco Dolstra
doc: builtins: use a definition list
2021-06-03Improve explanation of NIX_PATH prefix syntaxKeshav Kini
The previous wording seemed to imply that the "channel:" syntax would resolve to a github archive URL, which is not the case.
2021-05-11doc/nix-shell: Remove outdated bashrc informationLinus Heckemann
This behaviour was removed in 65f6d5db6f5ef2724a3dc03e1773c510123287f1.
2021-05-05doc: builtins: use a definition listAlyssa Ross
This looks a lot better (and is also more semantically meaningful). Since this list is generated in a Nix expression, I don't think using HTML here is going to be the thing that puts people off modifying this part of the documentation!
2021-04-29Merge pull request #4289 from abathur/encrypt_darwin_volumeGraham Christensen
darwin: encrypt nix volume if filevault is enabled
2021-04-29darwin: encrypt nix volume if filevault is enabledTravis A. Everett
2021-04-23Merge branch 'remove-trailing-spaces' of github.com:NixOS/nixEelco Dolstra
2021-04-23Replace the trailing markdown spaces by a backslashregnat
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..).
2021-04-23Merge pull request #4735 from NixOS/document-ca-derivationsEelco Dolstra
(briefly) document how to build ca derivations
2021-04-23Set more man sectionsEelco Dolstra
2021-04-23doc: fix section in nix3 man page metadataAlyssa Ross
These man pages said they were in section 7, even though we were installing them to section 1 (which is the right place for them).
2021-04-23(briefly) document how to build ca derivationsregnat
2021-04-05Revert "[prerequisites]: add JSON lib dependency"Björn Gohla
This reverts commit 5926200db09ca4d0c5769edf24a3cf2e9f472d23.
2021-04-01[prerequisites]: add JSON lib dependencyBjörn Gohla
2021-03-26Fix some typosEelco Dolstra
Fixes #4671.
2021-03-06remove doc for obsolete --no-build-hook flagTravis A. Everett
`--no-build-hook` appears to have been removed in 25f32625e2f2a3a1e1b3a3811da82f21c3a3b880
2021-02-25distributed builds: load remote builder host key from the machines fileGraham Christensen
This is already used by Hydra, and is very useful when materializing a remote builder list from service discovery. This allows the service discovery tool to only sync one file instead of two.
2021-02-24Respect command registrations in plugins.Shea Levy
2021-02-24Initialize plugins after handling initial command line flagsShea Levy
This is technically a breaking change, since attempting to set plugin files after the first non-flag argument will now throw an error. This is acceptable given the relative lack of stability in a plugin interface and the need to tie the knot somewhere once plugins can actually define new subcommands.
2021-02-17Restore warning about 'nix' being experimentalEelco Dolstra
Fixes #4552.
2021-02-16Update doc/manual/src/command-ref/nix-shell.mdMauricio Scheffer
Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
2021-02-16Fix Haskell exampleMauricio Scheffer
http://nixos.org redirects to https://nixos.org and apparently the HTTP library doesn't follow the redirect, so the output is empty. When defining https in the request it crashes because the library doesn't seem to support https. So this switches the example to a different http library.
2021-02-01Remove newline in operator table.Dominik Schrempf
2021-01-25Group common optionsEelco Dolstra
2021-01-25Group subcommands by categoryEelco Dolstra
2021-01-13Rename 'nix store sign-paths' to 'nix store sign'Eelco Dolstra
2021-01-11TweakEelco Dolstra
2020-12-31Fix `configure` error in introduction docSam Lidder
2020-12-25Update URL where bzip2 can be obtainedSevan Janiyan
2020-12-23Command: Remove examples()Eelco Dolstra
2020-12-21generate-manpage.nix: Fix short namesEelco Dolstra
2020-12-17smaller fixesRok Garbas
2020-12-08Switch away from classification as Tier1-3Rok Garbas
to classification to a more descriptive classification.
2020-12-08forgot to add the filesRok Garbas
2020-12-07Merge remote-tracking branch 'origin/master' into cli-guidelineRok Garbas
2020-12-04Make `make install` less noisyregnat
Remove the printing and useless output of a couple of commands when running `make install`
2020-12-03Remove 'dist' targetEelco Dolstra
We're not producing source tarballs anymore so this has been bitrotting.
2020-12-03Make doc() return arbitrary Markdown rather than the contents of the ↵Eelco Dolstra
"Description" section Thus we can return the examples section (and any other sections) from doc() and don't need examples() anymore.
2020-12-02Put examples first in the manpagesEelco Dolstra
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.