aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2023-04-06Add `Store::isTrustedClient()`matthewcroughan
This function returns true or false depending on whether the Nix client is trusted or not. Mostly relevant when speaking to a remote store with a daemon. We include this information in `nix ping store` and `nix doctor` Co-Authored-By: John Ericson <John.Ericson@Obsidian.Systems>
2023-04-06Document the concept of “experimental feature” (#5930)Théophane Hufschmitt
Add a page explaining what “experimental features” are, when and how they should be used Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Eelco Dolstra <edolstra@gmail.com> Co-authored-by: John Ericson <John.Ericson@Obsidian.Systems>
2023-04-05Merge pull request #7849 from milahu/fix-man-nix-shellValentin Gagarin
docs: fix nix-shell commands
2023-04-05docs: fix nix-shell commandsmilahu
2023-04-05add a definition of the nix database to the glossaryMike (stew) O'Connor
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-04-05add anchor to 'local store'Valentin Gagarin
2023-03-30process includes firstValentin Gagarin
otherwise the order of found `.md` files will influence if `@docroot@` is replaced before them being included, which may mess up relative links. the weirdest thing about it is that the mess-up happens deterministically on macOS, but deterministically doesn't happen on Linux!
2023-03-30Split nix-env and nix-store documentation per-subcommandAlexander Bantyev
Documentation on "classic" commands with many sub-commands are notoriously hard to discover due to lack of overview and anchor links. Additionally the information on common options and environment variables is not accessible offline in man pages, and therefore often overlooked by readers. With this change, each sub-command of nix-store and nix-env gets its own page in the manual (listed in the table of contents), and each own man page. Also, man pages for each subcommand now (again) list common options and environment variables. While this makes each page quite long and some common parameters don't apply, this should still make it easier to navigate as that additional information was not accessible on the command line at all. It is now possible to run 'nix-store --<subcommand> --help` to display help pages for the given subcommand. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-03-30Manual: fail when #include-d file does not existAlexander Bantyev
2023-03-27Fix more profile dirs in docsJohn Ericson
Picking up where #8078 left off.
2023-03-27Merge pull request #8084 from edolstra/store-docsEelco Dolstra
Auto-generate store documentation
2023-03-27Merge pull request #8062 from edolstra/ssl-cert-fileEelco Dolstra
Add a setting for configuring the SSL certificates file
2023-03-23Update release notesEelco Dolstra
2023-03-23Update doc/manual/src/release-notes/rl-next.mdEelco Dolstra
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-03-23showSetting: Drop ...Eelco Dolstra
2023-03-23Make useAnchors a named argumentEelco Dolstra
2023-03-23Merge pull request #8095 from fricklerhandwerk/operators-formattingEelco Dolstra
doc: force line breaks where needed
2023-03-23Merge pull request #6865 from zuzuleinen/manual-nix-path-emptyValentin Gagarin
document what happens when NIX_PATH is empty
2023-03-22add linksValentin Gagarin
2023-03-22doc: force line breaks where neededValentin Gagarin
2023-03-22Improve store setting descriptions / Markdown formattingEelco Dolstra
2023-03-22nix help-stores: Don't include anchorsEelco Dolstra
Since setting names are not unique we don't have an easy way to produce unique anchors.
2023-03-22Merge pull request #8082 from edolstra/add-linksEelco Dolstra
Add links to API docs / coverage analysis to the hacking section
2023-03-21FormattingEelco Dolstra
2023-03-21Support per-store Markdown documentationEelco Dolstra
2023-03-21nix describe-stores: RemoveEelco Dolstra
This command was intended for docs generation, but it was never used for that and we don't need it.
2023-03-21nix store --help: Include store type documentationEelco Dolstra
2023-03-21generate-manpage.nix: Make more readableEelco Dolstra
2023-03-21Add links to API docs / coverage analysis to the hacking sectionEelco Dolstra
2023-03-17Add a setting for configuring the SSL certificates fileEelco Dolstra
This provides a platform-independent way to configure the SSL certificates file in the Nix daemon. Previously we provided instructions for overriding the environment variable in launchd, but that obviously doesn't work with systemd. Now we can just tell users to add ssl-cert-file = /etc/ssl/my-certificate-bundle.crt to their nix.conf.
2023-03-16nix-hash: support base-64 and SRI formatYueh-Shun Li
Add the --base64 and --sri flags for the Base64 and SRI format output. Add the --base16 flag to explicitly specify the hexadecimal format. Add the --to-base64 and --to-sri flag to convert a hash to the above mentioned format.
2023-03-13Merge pull request #8036 from Freed-Wu/patch-1Valentin Gagarin
2023-03-13Merge pull request #7486 from fricklerhandwerk/doc-referenceEelco Dolstra
reword definition of "reference"
2023-03-13Fix a typo of values.mdwzy
2023-03-10Generate API docs with DoxygenJohn Ericson
The motivation is as stated in issue #7814: even though the the C++ API is internal and unstable, people still want it to be well documented for sake of learning, code review, and other purposes that aren't predicated on it being stable. Fixes #7814 Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-03-10Merge pull request #7928 from serokell/doc-includesValentin Gagarin
Documentation: process `#include` directives
2023-03-05clarify definition of "installable"Valentin Gagarin
the term was hard to discover, as its definition and explanation were in a very long document lacking an overview section. search did not help because it occurs so often. - clarify wording in the definition - add an overview of installable types - add "installable" to glossary - link to definition from occurrences of the term - be more precise about where store derivation outputs are processed - installable Nix expressions must evaluate to a derivation Co-authored-by: Adam Joseph <54836058+amjoseph-nixpkgs@users.noreply.github.com>
2023-03-03cosmetic indentationValentin Gagarin
Co-authored-by: Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com>
2023-03-02Merge branch 'master' into paths-from-stdinThéophane Hufschmitt
2023-03-02Merge pull request #7901 from hercules-ci/disable-testsEelco Dolstra
Add ./configure --disable-tests option
2023-03-01Documentation: process #include directivesAlexander Bantyev
2023-03-01doc/manual/local.mk: Use tabs instead of spaces everywhereAlexander Bantyev
2023-03-01Make nix-env less prominent in manual TOCAlexander Bantyev
2023-02-28Get rid of `.drv` special-casing for store path installablesJohn Ericson
The release notes document the change in behavior, I don't include it here so there is no risk to it getting out of sync. > Motivation >> Plumbing CLI should be simple Store derivation installations are intended as "plumbing": very simple utilities for advanced users and scripts, and not what regular users interact with. (Similarly, regular Git users will use branch and tag names not explicit hashes for most things.) The plumbing CLI should prize simplicity over convenience; that is its raison d'etre. If the user provides a path, we should treat it the same way not caring what sort of path it is. >> Scripting This is especially important for the scripting use-case. when arbitrary paths are sent to e.g. `nix copy` and the script author wants consistent behavior regardless of what those store paths are. Otherwise the script author needs to be careful to filter out `.drv` ones, and then run `nix copy` again with those paths and `--derivation`. That is not good! >> Surprisingly low impact Only two lines in the tests need changing, showing that the impact of this is pretty light. Many command, like `nix log` will continue to work with just the derivation passed as before. This because we used to: - Special case the drv path and replace it with it's outputs (what this gets rid of). - Turn those output path *back* into the original drv path. Now we just skip that entire round trip! > Context Issue #7261 lays out a broader vision for getting rid of `--derivation`, and has this as one of its dependencies. But we can do this with or without that. `Installable::toDerivations` is changed to handle the case of a `DerivedPath::Opaque` ending in `.drv`, which is new: it simply doesn't need to do any extra work in that case. On this basis, commands like `nix {show-derivation,log} /nix/store/...-foo.drv` still work as before, as described above. When testing older daemons, the post-build-hook will be run against the old CLI, so we need the old version of the post-build-hook to support that use-case. Co-authored-by: Travis A. Everett <travis.a.everett@gmail.com> Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-02-28doc/manual: add release note for `--stdin` flagTimothy DeHerrera
2023-02-28nix-store: read paths from standard inputTimothy DeHerrera
Resolves #7437 for new `nix-store` by adding a `--stdin` flag.
2023-02-28doc/cli-guideline: Improve examples Robert Hensing
Turns out that the settings themselves have a bad data model anyway, so we cut that. They do still occur in the first example, but not in focus.
2023-02-28doc/cli-guideline: Apply suggestions from code reviewRobert Hensing
Thanks Valentin!
2023-02-28doc/cli-guideline: Add JSON guidelineRobert Hensing
2023-02-28Release notesEelco Dolstra