Ryan Mulligan
2f92034d30
Merge pull request #125838 from jtojnar/strict-commonmark
...
doc: Parse as CommonMark
2021-06-07 06:02:29 -07:00
Jan Tojnar
3c78ad2561
doc: Use markdown syntax for xrefs
...
Syntax is taken from MyST:
https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
2021-06-07 06:34:59 +02:00
Antoine Martin
26ac257e4f
doc: nix-gitignore to CommonMark
...
Closes #125670
2021-06-05 18:20:26 +02:00
Erlend Pedersen
3452a739d1
nixpkgs-manual: lib.attrsets.mapAttrsToList returns a list ( #122179 )
2021-05-08 13:55:11 +02:00
Florian Engel
22cb630a66
Fix type description for attrByPath
...
The output type was missing
2021-03-14 10:27:26 +01:00
Robert Hensing
7d551ead60
doc: Format
2021-03-04 18:10:57 +01:00
Doron Behar
c858d0f63a
Merge pull request #105492 from alunduil/assertOneOf-typo
2021-02-07 18:44:50 +02:00
Jacek Galowicz
123045a570
lib/attrsets: add cartesianProductOfSets function
2021-01-28 23:08:59 +01:00
Alex Brandt
195fe01e8b
nixos/nixpkgs/docs: fix typo in assertOneOf example
...
This example was confusing at first because the element the message
indicated wasn't in the list of possible values was but the possible
values didn't match up either. This ensures the example is consistent
with the logic being presented.
2020-11-30 20:56:33 +00:00
Robert Hensing
e38a01db5d
Merge pull request #68491 from roberth/fix-dontRecurseIntoAttrs
...
Fix dontRecurseIntoAttrs + add to lib + doc
2020-03-01 11:05:34 +01:00
ivann
9605addd32
fix catAttrs documentation signature
2020-01-12 00:04:18 +01:00
Frederik Rietdijk
2b9713c281
doc: move fhs and mkShell under builders/special
...
In my opinion Functions should only contain pure functions. These are
both meant to provide derivations so I put them under Builders. Don't
know exactly *where* to put them so "special" it is...
2019-10-21 11:39:46 +02:00
Frederik Rietdijk
24b1ef5133
doc: move overrides into separate chapter
2019-10-21 11:19:46 +02:00
Frederik Rietdijk
9d54ea9b2d
doc: move image builders into new images chapter
2019-10-21 10:57:56 +02:00
Frederik Rietdijk
16d733bbe5
doc: move fetchers and trivial builders under builders
2019-10-20 13:35:04 +02:00
Jan Tojnar
83c2ad80ca
doc: re-format
2019-09-18 22:12:54 +02:00
worldofpeace
cd518845e2
doc/stdenv: document meson variables
2019-09-17 21:30:09 -04:00
Robert Hensing
a96f37db10
Document attrsets.recurseIntoAttrs
2019-09-11 14:55:23 +02:00
Katharina Fey
e72ec381b2
ociTools: fixing outdated documentation
2019-09-09 08:05:33 +01:00
Katharina Fey
18f7f19ce2
ociTools: init
2019-09-04 22:46:42 +00:00
Graham Christensen
abf82a18fb
doc/functions/dockertools.xml: clarify that "Commands" means shell commands
...
Co-Authored-By: Jon <jonringer@users.noreply.github.com>
2019-08-15 09:47:05 -04:00
Graham Christensen
8adaae2df2
dockertools.buildLayeredImage: default layer count up to 100
2019-08-12 19:59:40 -04:00
Graham Christensen
2e6a16f2bd
dockerTools: document extraCommands
2019-08-12 19:56:57 -04:00
Graham Christensen
dc336293a1
doc: fix after snaptools merge
2019-07-10 08:02:14 -07:00
Graham Christensen
a82901fb5e
snapTools.makeSnap: init
2019-06-18 18:51:58 +02:00
Jan Tojnar
a3f2131eb6
doc: Use prompt more often
2019-06-17 13:25:50 +02:00
Jan Tojnar
3c14bda7f5
doc: fix spurious whitespace
2019-06-17 12:28:26 +02:00
Jaka Hudoklin
c087b608e8
Merge pull request #58360 from xtruder/pkgs/dockerTools/nix-prefetch-docker
...
dockerTools: add nix-prefetch-docker script
2019-04-06 14:44:19 +02:00
Jaka Hudoklin
c1f0d19785
dockerTools: add nix-prefetch-docker script
2019-04-06 14:16:40 +02:00
Jaka Hudoklin
468df177c4
dockerTools: add finalImageName parameter for pullImage
2019-03-26 19:35:14 +01:00
Wael Nasreddine
a7f4fd0014
doc: format the documentation ( #57102 )
2019-03-08 21:07:11 -08:00
Jörg Thalheim
dadc7eb329
treewide: use runtimeShell instead of stdenv.shell whenever possible
...
Whenever we create scripts that are installed to $out, we must use runtimeShell
in order to get the shell that can be executed on the machine we create the
package for. This is relevant for cross-compiling. The only use case for
stdenv.shell are scripts that are executed as part of the build system.
Usages in checkPhase are borderline however to decrease the likelyhood
of people copying the wrong examples, I decided to use runtimeShell as well.
2019-02-26 14:10:49 +00:00
Graham Christensen
695fb802f1
Merge pull request #54693 from tilpner/appimage-tools
...
appimageTools: init
2019-02-23 18:06:31 -05:00
tilpner
58443d8a50
appimageTools: init
...
The appimageTools attrset contains utilities to prevent
the usage of appimage-run to package AppImages, like done/attempted
in #49370 and #53156 .
This has the advantage of allowing for per-package environment changes,
and extracts into the store instead of the users home directory.
The package list was extracted into appimageTools to prevent
duplication.
2019-02-23 21:04:21 +01:00
Raitis Veinbahs
d8a7a01fec
nix-gitignore: init at v3.0.0 ( #46112 )
...
closes siers/nix-gitignore#6
2019-02-18 09:57:30 +00:00
Alexandre Esteves
9e7625983b
Fix typos in docker tools docs
2019-01-30 16:37:43 +00:00
Matthew Bauer
a376d62441
nixpkgs/manual: add one more fix for a missed review
2019-01-27 12:01:23 -05:00
Matthew Bauer
d7b62cb601
nixpkgs/manual: address review comments
...
Mostly taken from requested changes exactly as recommended.
2019-01-27 11:57:36 -05:00
Matthew Bauer
498a242bf4
nixpkgs/manual: add trivial builders section
...
Fixes #25507 .
2019-01-26 22:48:47 -05:00
Matthew Bauer
17ec7f3a16
nixpkgs/manual: document fetcher functions
...
Fixes #32439 .
2019-01-26 22:48:47 -05:00
Jörg Thalheim
eac6797380
prefer-fetch-remote: an overlay to fetch on remote builders
...
This is useful when running tools like NixOps or nix-review
on workstations where the upload to the builder is significantly
slower then downloading the source on the builder itself.
2019-01-18 14:41:10 +00:00
Vincent Ambo
0c99dac497
doc: Add automatic generation of library function documentation
...
Modifies the build process of the manual to invoke nixdoc
automatically to generate XML files with function documentation.
Currently documentation is present for five of the files in `lib/`.
To add another file to the generated docs, both
`doc/functions/library.xml` and `doc/lib-function-docs.nix` must be
updated.
2019-01-04 11:28:27 +01:00
John Ericson
b71389aefb
Merge pull request #47430 from roberth/nixpkgs-extend
...
pkgs.extend for adding overlays
2018-10-23 20:21:48 -04:00
Ingo Blechschmidt
00b555ef88
nixpkgs docs: Fix tiny typo ( #48477 )
2018-10-23 14:41:15 +00:00
Robert Hensing
a5c4642ddf
doc: Add link from overrides to overlays
2018-10-19 12:25:17 +02:00
Robert Hensing
3c2ae189c2
doc: Improve overrides and overlays documentation
2018-10-18 14:01:06 +02:00
Robert Hensing
9b7654f6ff
nixpkgs docs: Point to pkgs.extend, pkgs.appendOverlays and improve override section
2018-10-18 10:48:43 +02:00
Graham Christensen
0eb3b93e1a
nixpkgs docs: document recursivelyUpdate
2018-10-12 16:54:34 -04:00
Graham Christensen
c100a456b1
nixpkgs docs: document recursivelyUpdateUntil
2018-10-12 16:54:34 -04:00
Graham Christensen
77140a9075
nixpkgs docs: document zipAttrs
2018-10-12 16:54:34 -04:00