lix-project/lix
20
57
Fork 31
Code Issues 344 Code Review (Gerrit) Projects 3 Releases Wiki Activity
lix/doc/manual/src/SUMMARY.md.in

160 lines
8.9 KiB
Markdown
Raw Normal View History

Use mdbook
2020-07-22 18:27:23 +00:00
# Table of Contents
Pandoc conversion
2020-07-22 21:17:48 +00:00
- [Introduction](introduction.md)
- [Quick Start](quick-start.md)
- [Installation](installation/installation.md)
- [Supported Platforms](installation/supported-platforms.md)
- [Installing a Binary Distribution](installation/installing-binary.md)
- [Installing Nix from Source](installation/installing-source.md)
- [Prerequisites](installation/prerequisites-source.md)
- [Obtaining a Source Distribution](installation/obtaining-source.md)
- [Building Nix from Source](installation/building-source.md)
Documenting how to use/build Nix' Docker image
2021-11-11 15:03:09 +00:00
- [Using Nix within Docker](installation/installing-docker.md)
Pandoc conversion
2020-07-22 21:17:48 +00:00
- [Security](installation/nix-security.md)
- [Single-User Mode](installation/single-user.md)
- [Multi-User Mode](installation/multi-user.md)
- [Environment Variables](installation/env-variables.md)
- [Upgrading Nix](installation/upgrading.md)
move uninstall instructions to a separate page placed in a subsection of the binary install, the instructions are hard to find. putting them in a separate page that is shown in the table of contents should make it easier for users to find what they need when they need it.
2023-04-28 09:53:37 +00:00
- [Uninstalling Nix](installation/uninstall.md)
Pandoc conversion
2020-07-22 21:17:48 +00:00
- [Package Management](package-management/package-management.md)
- [Basic Package Management](package-management/basic-package-mgmt.md)
- [Profiles](package-management/profiles.md)
- [Garbage Collection](package-management/garbage-collection.md)
- [Garbage Collector Roots](package-management/garbage-collector-roots.md)
- [Sharing Packages Between Machines](package-management/sharing-packages.md)
- [Serving a Nix store via HTTP](package-management/binary-cache-substituter.md)
Sigh
2020-07-23 12:30:13 +00:00
- [Copying Closures via SSH](package-management/copy-closure.md)
Pandoc conversion
2020-07-22 21:17:48 +00:00
- [Serving a Nix store via SSH](package-management/ssh-substituter.md)
Sigh
2020-07-23 12:30:13 +00:00
- [Serving a Nix store via S3](package-management/s3-substituter.md)
manual: remove "Writing Nix Expressions" chapter it is out of date, all over the place in level of detail, is really about `nixpkgs`, and in general instructions should not be part of a reference manual. also: - update redirects and internal links - use "Nix language" consistently
2022-08-04 09:36:32 +00:00
- [Nix Language](language/index.md)
- [Data Types](language/values.md)
- [Language Constructs](language/constructs.md)
antiquotation -> string interpolation as proposed by @mkaito[1] and @tazjin[2] and discussed with @edolstra and Nix maintainers [1]: https://github.com/NixOS/nix.dev/pull/267#issuecomment-1270076332 [2]: https://github.com/NixOS/nix.dev/pull/267#issuecomment-1270201979 Co-authored-by: John Ericson <git@JohnEricson.me> Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
2022-11-08 23:31:48 +00:00
- [String interpolation](language/string-interpolation.md)
manual: remove "Writing Nix Expressions" chapter it is out of date, all over the place in level of detail, is really about `nixpkgs`, and in general instructions should not be part of a reference manual. also: - update redirects and internal links - use "Nix language" consistently
2022-08-04 09:36:32 +00:00
- [Operators](language/operators.md)
- [Derivations](language/derivations.md)
- [Advanced Attributes](language/advanced-attributes.md)
- [Built-in Constants](language/builtin-constants.md)
- [Built-in Functions](language/builtins.md)
Pandoc conversion
2020-07-22 21:17:48 +00:00
- [Advanced Topics](advanced-topics/advanced-topics.md)
- [Remote Builds](advanced-topics/distributed-builds.md)
- [Tuning Cores and Jobs](advanced-topics/cores-vs-jobs.md)
- [Verifying Build Reproducibility](advanced-topics/diff-hook.md)
- [Using the `post-build-hook`](advanced-topics/post-build-hook.md)
- [Command Reference](command-ref/command-ref.md)
Reconvert
2020-07-23 08:44:54 +00:00
- [Common Options](command-ref/opt-common.md)
- [Common Environment Variables](command-ref/env-common.md)
Convert commands
2020-07-23 10:58:42 +00:00
- [Main Commands](command-ref/main-commands.md)
- [nix-build](command-ref/nix-build.md)
- [nix-shell](command-ref/nix-shell.md)
- [nix-store](command-ref/nix-store.md)
Split nix-env and nix-store documentation per-subcommand 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-23 15:27:41 +00:00
- [nix-store --add-fixed](command-ref/nix-store/add-fixed.md)
- [nix-store --add](command-ref/nix-store/add.md)
- [nix-store --delete](command-ref/nix-store/delete.md)
- [nix-store --dump-db](command-ref/nix-store/dump-db.md)
- [nix-store --dump](command-ref/nix-store/dump.md)
- [nix-store --export](command-ref/nix-store/export.md)
- [nix-store --gc](command-ref/nix-store/gc.md)
- [nix-store --generate-binary-cache-key](command-ref/nix-store/generate-binary-cache-key.md)
- [nix-store --import](command-ref/nix-store/import.md)
- [nix-store --load-db](command-ref/nix-store/load-db.md)
- [nix-store --optimise](command-ref/nix-store/optimise.md)
- [nix-store --print-env](command-ref/nix-store/print-env.md)
- [nix-store --query](command-ref/nix-store/query.md)
- [nix-store --read-log](command-ref/nix-store/read-log.md)
- [nix-store --realise](command-ref/nix-store/realise.md)
- [nix-store --repair-path](command-ref/nix-store/repair-path.md)
- [nix-store --restore](command-ref/nix-store/restore.md)
- [nix-store --serve](command-ref/nix-store/serve.md)
- [nix-store --verify-path](command-ref/nix-store/verify-path.md)
- [nix-store --verify](command-ref/nix-store/verify.md)
Make nix-env less prominent in manual TOC
2023-03-01 09:54:45 +00:00
- [nix-env](command-ref/nix-env.md)
Split nix-env and nix-store documentation per-subcommand 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-23 15:27:41 +00:00
- [nix-env --delete-generations](command-ref/nix-env/delete-generations.md)
- [nix-env --install](command-ref/nix-env/install.md)
- [nix-env --list-generations](command-ref/nix-env/list-generations.md)
- [nix-env --query](command-ref/nix-env/query.md)
- [nix-env --rollback](command-ref/nix-env/rollback.md)
- [nix-env --set-flag](command-ref/nix-env/set-flag.md)
- [nix-env --set](command-ref/nix-env/set.md)
- [nix-env --switch-generation](command-ref/nix-env/switch-generation.md)
- [nix-env --switch-profile](command-ref/nix-env/switch-profile.md)
- [nix-env --uninstall](command-ref/nix-env/uninstall.md)
- [nix-env --upgrade](command-ref/nix-env/upgrade.md)
Pandoc conversion
2020-07-22 21:17:48 +00:00
- [Utilities](command-ref/utilities.md)
Convert commands
2020-07-23 10:58:42 +00:00
- [nix-channel](command-ref/nix-channel.md)
- [nix-collect-garbage](command-ref/nix-collect-garbage.md)
Pandoc conversion
2020-07-22 21:17:48 +00:00
- [nix-copy-closure](command-ref/nix-copy-closure.md)
Convert commands
2020-07-23 10:58:42 +00:00
- [nix-daemon](command-ref/nix-daemon.md)
- [nix-hash](command-ref/nix-hash.md)
- [nix-instantiate](command-ref/nix-instantiate.md)
- [nix-prefetch-url](command-ref/nix-prefetch-url.md)
Start generation of the nix.1 manpage
2020-08-17 17:33:18 +00:00
- [Experimental Commands](command-ref/experimental-commands.md)
Documentation: process #include directives
2023-03-01 10:01:45 +00:00
{{#include ./command-ref/new-cli/SUMMARY.md}}
Convert nix.conf manpage
2020-07-23 08:56:15 +00:00
- [Files](command-ref/files.md)
- [nix.conf](command-ref/conf-file.md)
display documentation on manifest files separately it's probably better not to show the manifest file documentation in the command-specific pages, because these are implementation details that are not really practically useful. this means no additional hassle for building the manual, but clutters the table of contents a bit.
2023-04-27 09:56:52 +00:00
- [Profiles](command-ref/files/profiles.md)
- [manifest.nix](command-ref/files/manifest.nix.md)
- [manifest.json](command-ref/files/manifest.json.md)
Document user files of nix
2023-02-17 17:57:15 +00:00
- [Channels](command-ref/files/channels.md)
- [Default Nix expression](command-ref/files/default-nix-expression.md)
Add description for file system objects (#8500) While this is not actually a notion in the implementation, it is explicitly described in the thesis and quite important for understanding how the store works. Co-authored-by: John Ericson <git@JohnEricson.me> Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-06-19 03:45:08 +00:00
- [Architecture and Design](architecture/architecture.md)
- [File System Object](architecture/file-system-object.md)
Add docs
2023-06-16 13:58:42 +00:00
- [Protocols](protocols/protocols.md)
- [Serving Tarball Flakes](protocols/tarball-fetcher.md)
Pandoc conversion
2020-07-22 21:17:48 +00:00
- [Glossary](glossary.md)
Merge remote-tracking branch 'origin/master' into cli-guideline
2020-12-07 14:13:36 +00:00
- [Contributing](contributing/contributing.md)
- [Hacking](contributing/hacking.md)
Split testing into its own page in the contribution guide `hacking.md` has gotten really big!
2023-06-22 03:33:33 +00:00
- [Testing](contributing/testing.md)
Document the concept of “experimental feature” (#5930) 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-06 11:25:22 +00:00
- [Experimental Features](contributing/experimental-features.md)
Merge remote-tracking branch 'origin/master' into cli-guideline
2020-12-07 14:13:36 +00:00
- [CLI guideline](contributing/cli-guideline.md)
Split out worker protocol template definitions from declarations This is generally a fine practice: Putting implementations in headers makes them harder to read and slows compilation. Unfortunately it is necessary for templates, but we can ameliorate that by putting them in a separate header. Only files which need to instantiate those templates will need to include the header with the implementation; the rest can just include the declaration. This is now documenting in the contributing guide. Also, it just happens that these polymorphic serializers are the protocol agnostic ones. (Worker and serve protocol have the same logic for these container types.) This means by doing this general template cleanup, we are also getting a head start on better indicating which code is protocol-specific and which code is shared between protocols.
2022-03-08 21:53:26 +00:00
- [C++ style guide](contributing/cxx.md)
Pandoc conversion
2020-07-22 21:17:48 +00:00
- [Release Notes](release-notes/release-notes.md)
Rename rl-2.5.md to rl-next.md Having a generically named file for release notes for the next release makes things easier for PRs.
2021-10-28 12:36:47 +00:00
- [Release X.Y (202?-??-??)](release-notes/rl-next.md)
Typo
2023-05-31 12:05:00 +00:00
- [Release 2.16 (2023-05-31)](release-notes/rl-2.16.md)
Release notes
2023-04-11 10:40:14 +00:00
- [Release 2.15 (2023-04-11)](release-notes/rl-2.15.md)
Release notes
2023-02-28 12:44:14 +00:00
- [Release 2.14 (2023-02-28)](release-notes/rl-2.14.md)
Release notes
2023-01-17 12:23:31 +00:00
- [Release 2.13 (2023-01-17)](release-notes/rl-2.13.md)
Release notes
2022-12-06 12:55:09 +00:00
- [Release 2.12 (2022-12-06)](release-notes/rl-2.12.md)
Branch 2.11 release notes
2022-08-24 20:44:58 +00:00
- [Release 2.11 (2022-08-25)](release-notes/rl-2.11.md)
Branch 2.10 release notes
2022-07-11 19:10:23 +00:00
- [Release 2.10 (2022-07-11)](release-notes/rl-2.10.md)
Branch 2.9 release notes
2022-05-30 18:39:38 +00:00
- [Release 2.9 (2022-05-30)](release-notes/rl-2.9.md)
Move rl-next.md to rl-2.8.md
2022-04-19 19:12:33 +00:00
- [Release 2.8 (2022-04-19)](release-notes/rl-2.8.md)
Move rl-next.md to rl-2.7.md
2022-03-07 19:10:18 +00:00
- [Release 2.7 (2022-03-07)](release-notes/rl-2.7.md)
Move rl-next.md to rl-2.5.md
2022-01-24 23:11:00 +00:00
- [Release 2.6 (2022-01-24)](release-notes/rl-2.6.md)
Move rl-next.md to rl-2.5.md
2021-12-13 15:48:44 +00:00
- [Release 2.5 (2021-12-13)](release-notes/rl-2.5.md)
Rename rl-2.5.md to rl-next.md Having a generically named file for release notes for the next release makes things easier for PRs.
2021-10-28 12:36:47 +00:00
- [Release 2.4 (2021-11-01)](release-notes/rl-2.4.md)
Pandoc conversion
2020-07-22 21:17:48 +00:00
- [Release 2.3 (2019-09-04)](release-notes/rl-2.3.md)
- [Release 2.2 (2019-01-11)](release-notes/rl-2.2.md)
- [Release 2.1 (2018-09-02)](release-notes/rl-2.1.md)
- [Release 2.0 (2018-02-22)](release-notes/rl-2.0.md)
- [Release 1.11.10 (2017-06-12)](release-notes/rl-1.11.10.md)
- [Release 1.11 (2016-01-19)](release-notes/rl-1.11.md)
- [Release 1.10 (2015-09-03)](release-notes/rl-1.10.md)
- [Release 1.9 (2015-06-12)](release-notes/rl-1.9.md)
- [Release 1.8 (2014-12-14)](release-notes/rl-1.8.md)
- [Release 1.7 (2014-04-11)](release-notes/rl-1.7.md)
- [Release 1.6.1 (2013-10-28)](release-notes/rl-1.6.1.md)
- [Release 1.6 (2013-09-10)](release-notes/rl-1.6.md)
- [Release 1.5.2 (2013-05-13)](release-notes/rl-1.5.2.md)
- [Release 1.5 (2013-02-27)](release-notes/rl-1.5.md)
- [Release 1.4 (2013-02-26)](release-notes/rl-1.4.md)
- [Release 1.3 (2013-01-04)](release-notes/rl-1.3.md)
- [Release 1.2 (2012-12-06)](release-notes/rl-1.2.md)
- [Release 1.1 (2012-07-18)](release-notes/rl-1.1.md)
- [Release 1.0 (2012-05-11)](release-notes/rl-1.0.md)
- [Release 0.16 (2010-08-17)](release-notes/rl-0.16.md)
- [Release 0.15 (2010-03-17)](release-notes/rl-0.15.md)
- [Release 0.14 (2010-02-04)](release-notes/rl-0.14.md)
- [Release 0.13 (2009-11-05)](release-notes/rl-0.13.md)
- [Release 0.12 (2008-11-20)](release-notes/rl-0.12.md)
- [Release 0.11 (2007-12-31)](release-notes/rl-0.11.md)
- [Release 0.10.1 (2006-10-11)](release-notes/rl-0.10.1.md)
- [Release 0.10 (2006-10-06)](release-notes/rl-0.10.md)
- [Release 0.9.2 (2005-09-21)](release-notes/rl-0.9.2.md)
- [Release 0.9.1 (2005-09-20)](release-notes/rl-0.9.1.md)
- [Release 0.9 (2005-09-16)](release-notes/rl-0.9.md)
- [Release 0.8.1 (2005-04-13)](release-notes/rl-0.8.1.md)
- [Release 0.8 (2005-04-11)](release-notes/rl-0.8.md)
- [Release 0.7 (2005-01-12)](release-notes/rl-0.7.md)
- [Release 0.6 (2004-11-14)](release-notes/rl-0.6.md)
- [Release 0.5 and earlier](release-notes/rl-0.5.md)
Reference in a new issue Copy permalink