aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2022-08-04Update doc/manual/src/design/overview.mdJohn Ericson
Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>
2022-08-04Update doc/manual/src/design/overview.mdJohn Ericson
Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>
2022-08-04Update doc/manual/src/design/overview.mdJohn Ericson
Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>
2022-08-04Fix stub file's nameJohn Ericson
2022-08-04Start on the derivations sectionJohn Ericson
2022-08-04Move the bits on relocating store entires to the endJohn Ericson
They are too advanced for up front.
2022-08-04Apply suggestions from code reviewJohn Ericson
2022-08-04Flesh out TOCJohn Ericson
2022-08-04Briefly describe the digest of a store pathJohn Ericson
2022-08-04WIP: Document the design of NixJohn Ericson
The current docs are all "how to do things" and no "what is Nix" or "why are things the way they are". I see lots of misconception on the wider internet, and I also think we would benefit from a "living document" to answer some questions people currently turn to the thesis for. I think a new section of the manual can address all these issues.
2022-08-03Merge pull request #6846 from fricklerhandwerk/valuesThéophane Hufschmitt
manual: use subheadings for primitive types
2022-08-03Fix the html id of the list headersThéophane Hufschmitt
2022-08-03encode primitive as list with anchorsValentin Gagarin
to make it consistent with builtins and configuration options
2022-08-01doc/distributed-builds: don't use deprecated aliasK900
`nix ping-store` -> `nix store ping`.
2022-07-28manual: use singular in body, tooValentin Gagarin
Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
2022-07-28manual: values -> data typesValentin Gagarin
2022-07-28manual: use singular for headingsValentin Gagarin
2022-07-28manual: simple values -> primitivesValentin Gagarin
"simple" is a loaded term
2022-07-28manual: use subheadings for primitive typesValentin Gagarin
this gives us HTML anchors for each of them
2022-07-28manual: set -> attribute setValentin Gagarin
reword description to have shorter sentences.
2022-07-28manual: fix section title in table of contentsValentin Gagarin
2022-07-11Branch 2.10 release notesEelco Dolstra
2022-07-11Merge pull request #6777 from laalsaas/masterEelco Dolstra
Fix logical and typographical errors in nix-env man page
2022-07-11Update release notesEelco Dolstra
2022-07-10Fix logical and typographical errors in nix-env man pagelaalsaas
2022-07-06Add a release notes entry for #4914Théophane Hufschmitt
cc @gytis-ivaskevicius
2022-06-15Merge branch 'master' into nix-repl-flakesTom Bereknyei
2022-06-15Apply suggestions from code reviewtomberek
Co-authored-by: Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com>
2022-06-14Add disambiguation to man pageHugo Osvaldo Barrera
This should help future lost newcomers like myself understand where to find the docs for both of these commands and how they differ.
2022-06-02Merge branch 'master' into nix-repl-flakesTom Bereknyei
2022-06-01Merge branch 'master' into ltoThéophane Hufschmitt
2022-05-31TypoEelco Dolstra
2022-05-30Branch 2.9 release notesEelco Dolstra
2022-05-30Respect the outputSpecified attributeEelco Dolstra
E.g. 'nix build nixpkgs#libxml2.dev' will build the 'dev' output.
2022-05-27Merge branch 'doc-redirects' of https://github.com/jtojnar/nixEelco Dolstra
2022-05-26doc: Add redirects for the DocBook manualJan Tojnar
There are still many links to the old manual on the web and having them end up on the Introduction page is a bad user experience.
2022-05-26doc: Manually insert some anchorsJan Tojnar
2022-05-26doc: Add anchors to long listsJan Tojnar
Added using the following sed scripts: - For command-ref/opt-common.md: s~- `(--?)([^`]+)`~- [`\1\2`]{#opt-\2}~g - For expressions/builtin-constants.md: s~- `(builtins\.?)([^`]+)`~- [`\1\2`]{#builtins-\2}~g - For expressions/advanced-attributes.md s~^ - `([^`]+)`~ - [`\1`]{#adv-attr-\1}~g and manually adjusted outputHashAlgo & outputHashMode. - For glossary.md s~^ - (`([^`]+)`|(.+)) ?\\~ - [\1]{#gloss-\2\3}\\~g; s~(gloss-\w+) ~\1-~g and manually adjusted anchors for Nix expression, user environment, NAR, ∅ and ε. - For command-ref/env-common.md s~^ - `([^`]+)`~ - [`\1`]{#env-\1}~g'
2022-05-26doc: Port anchors preprocessor to jq scriptJan Tojnar
Python is only pulled into the build closure by Mercurial, which might end up being removed. Let’s port the script to jq, which is more likely to stay.
2022-05-26doc: Introduce pre-processor for adding anchors to textJan Tojnar
It is now possible to use the following syntax to insert anchors into the text: []{#anchor-name} The anchor will allow linking to the location it is placed by appending #anchor-name to the URL. Additionally, it is possible to create a link pointing to its own location by adding text between the square brackets: [`--add-root`]{#opt-add-root}
2022-05-26Tweak IN_NIX_SHELL descriptionEelco Dolstra
2022-05-25Merge branch 'master' into debug-exploratory-PRBen Burdette
2022-05-25add --debugger to rl-next listBen Burdette
2022-05-25Merge branch 'master' into ltopennae
2022-05-20repl: clarify change and usage of <nixpkgs>Tom Bereknyei
2022-05-19fetchTree: Allow fetching plain filesTony Olagbaiye
Add a new `file` fetcher type, which will fetch a plain file over http(s), or from the local file. Because plain `http(s)://` or `file://` urls can already correspond to `tarball` inputs (if the path ends-up with a know archive extension), the URL parsing logic is a bit convuluted in that: - {http,https,file}:// urls will be interpreted as either a tarball or a file input, depending on the extensions of the path part (so `https://foo.com/bar` will be a `file` input and `https://foo.com/bar.tar.gz` as a `tarball` input) - `file+{something}://` urls will be interpreted as `file` urls (with the `file+` part removed) - `tarball+{something}://` urls will be interpreted as `tarball` urls (with the `tarball+` part removed) Fix #3785 Co-Authored-By: Tony Olagbaiye <me@fron.io>
2022-05-18repl: update docs with installablesTom Bereknyei
2022-05-12Don’t recommend writing unit testsThéophane Hufschmitt
As asked in <https://github.com/NixOS/nix/pull/6517#discussion_r869416905>
2022-05-10Expand the testing section of the hacking docsThéophane Hufschmitt
- Make it clear what the different kind of tests are, where they live and how they can be ran - Ask people to primarily write unit tests
2022-05-03Allow selecting derivation outputs using 'installable!outputs'Eelco Dolstra
E.g. 'nixpkgs#glibc^dev,static' or 'nixpkgs#glibc^*'.