Commit graph

169 commits

Author SHA1 Message Date
Ryan Mulligan
f3d0e1d5c3 nixpkgs/doc: fix admonition syntax
Match admonition syntax in

https://nixos.org/manual/nixpkgs/unstable/#chap-contributing
2022-11-08 07:30:20 -08:00
Дамјан Георгиевски
4e385bec15
add documentation for the pkgs.portableService tool (#193081)
* add documentation for the pkgs.portableService tool

as introduced in 499aebcf34

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-10-07 10:37:56 +02:00
Ivar Scholten
6c40872147
doc/testers: testVersion -> testers.testVersion, add example 2022-09-15 22:46:37 +02:00
Robert Hensing
62b25a28fe
Merge pull request #170906 from Sohalt/dockerTools.ca-certificates.crt
dockerTools ca-certificates.crt helper
2022-08-31 14:08:02 +02:00
Alex James
c9af898255
dockerTools.buildImage: make VM memSize configurable
Fixes #186752. This adds buildVMMemorySize (defaults to 512 MiB) to
buildImage, which is passed to vm.runInLinuxVM. This is needed for
larger base images, which may otherwise cause container build failures
due to OOM in the VM.
2022-08-16 21:47:29 -05:00
Winter
dbd18a63a7 fetchgit: allow disabling cone mode for sparse checkouts, fix test 2022-08-14 23:03:07 +02:00
Florian Klink
00ff154265
Merge pull request #174093 from NixOS/doc-fakenss
nixos/doc: document fakeNss, binSh
2022-08-04 21:06:19 +07:00
Valentin Gagarin
671ce969a9
Merge pull request #179489 from Thornycrackers-Forks/fetcher-docs-update
doc/builders/fetchers: Add examples, reduce sentence complexity
2022-08-03 11:50:56 +02:00
Cody Hiar
3c2cd351d4 Add example error message. 2022-08-02 11:07:36 -06:00
Cody Hiar
9c292dd02e Updating sha256 to more realistic example 2022-08-02 10:55:15 -06:00
Cody Hiar
0e91d53cc5
Update doc/builders/fetchers.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-02 10:52:08 -06:00
Cody Hiar
0685e4a929
Update doc/builders/fetchers.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-02 10:51:38 -06:00
Cody Hiar
6d0bf6ae05
Update doc/builders/fetchers.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-02 10:51:09 -06:00
Cody Hiar
0444078dab
Update doc/builders/fetchers.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-02 10:50:22 -06:00
Cody Hiar
53ffebbe1f
Update doc/builders/fetchers.chapter.md
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-02 10:50:05 -06:00
Florian Klink
6e254a6c35 nixos/doc: update contents to copyToRoot
contents is deprecated now, use the copyToRoot attribute.
2022-08-01 13:41:41 +07:00
Florian Klink
4393ed8679 Update doc/builders/images/dockertools.section.md
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2022-08-01 13:34:20 +07:00
Florian Klink
d84e7842a5 nixos/doc: document fakeNss, binSh 2022-08-01 13:34:20 +07:00
Arnout Engelen
0dd7792b4c
nixpkgs/doc: remove unused unfree.xml
This section was broken out into its own file in efb55d2a42 but
apparently never actually got included anywhere.

Since then a more detailed section on using unfree packages has been
introduced.

Copied the introduction and removed the rest of the file.
2022-07-28 16:54:32 +02:00
Cody Hiar
f25dd50085
Update doc/builders/fetchers.chapter.md
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2022-07-18 11:26:51 -06:00
sohalt
c9d8e34fc4 dockerTools: document environment helpers 2022-07-07 14:50:23 +02:00
Robert Hensing
e007eb480c dockerTools.buildImage: Add copyToRoot to replace contents, explain usage 2022-07-06 07:30:24 +02:00
Cody Hiar
6a9987a095 Updated wording from code review 2022-07-04 14:39:11 -06:00
Cody Hiar
24e95a4461 Remove possessive apostrophes 2022-06-29 12:50:16 -06:00
Cody Hiar
48d5f38c6a doc/builders/fetchers: Add examples, reduce sentence complexity 2022-06-28 17:18:48 -06:00
adisbladis
02c180b646
Merge pull request #176324 from meebey/meebey/meebey-patch-1
doc/builders/images/dockertools: improve shadowSetup example
2022-06-21 20:24:20 +08:00
Mirco Bauer
ac66ff97ed doc/builders/images/dockertools: improve shadowSetup example
The example snippet will fail with this error as it is not self contained and
assumes `shadowSetup` was given:

    $ nix-build docker-image.nix
    error: undefined variable 'shadowSetup' at docker-image.nix:20:7

Instead use the full reference to `shadowSetup` in the example so it will work
as stated.
2022-06-05 09:45:58 +08:00
Florian Klink
1cefcfab2d nixos/doc: move fetchpatch documentation to fetcher documentation
… and link from the coding-conventions chapter to it.

Closes #48569.
2022-06-03 14:37:31 +02:00
Klemens Nanni
787a444596 doc: firefox: Show how to use PKCS#11 Proxy Module
`p11-kit-proxy.so` makes it able to use multiple PKCS#11 modules and
manage them through p11-kit(8).

Fix indentation while here.
2022-06-01 01:22:46 +02:00
Robert Hensing
e8ffb6a727 doc/testers: Mention nixosTests in nixosTest doc 2022-05-05 13:08:05 +02:00
Robert Hensing
7edb414660 testers.nixosTest: Move from top-level and improve docs 2022-05-05 12:48:47 +02:00
Sandro
beec499a8a
Merge pull request #163598 from SuperSamus/doc-builder-typos
doc/builders: fix typos
2022-05-03 09:41:34 +02:00
Artturin
41808d42d2 doc: move testers to their own chapter 2022-04-22 16:24:29 +03:00
jahway603
021d10cde0 added fetchFromGitea to docs 2022-03-21 12:39:17 -04:00
Artturi
b54e7571e2
Merge pull request #161739 from Artturin/gsettingsfhsenv 2022-03-15 00:03:56 +02:00
Martino Fontana
93d624a49a doc/builders: fix typos 2022-03-10 20:43:29 +01:00
Artturin
3e7e6ab84a buildFHSUserEnv{Chroot,Bubblewrap}: link gsettings-schemas to the FHS location
We shouldn't need to use wrapGAppsHook in expressions
that use this builder.
2022-03-03 01:22:09 +02:00
Jonathan Ringer
5f91781b55 treewide: remove steam-run-native 2022-03-02 12:25:45 -08:00
Zhong Jianxin
8c26b2d60f fetchgit: Add document for sparseCheckout 2022-01-24 11:23:56 +08:00
Robert Hensing
d75b85c5dc
Merge pull request #147690 from pasqui23/hosts
concatTextFile: init
2022-01-08 20:40:31 +01:00
Jonas Chevalier
1e910209ae
mkShell: make it buildable (#153194)
When I designed `mkShell`, I didn't have a good idea of what the output
should look like and so decided to make the build fail. In practice,
this causes quite a bit of confusion and complications because now the
shell cannot be part of a normal package set without failing the CI as
well.

This commit changes that build phase to record all the build inputs in a
file. That way it becomes possible to build it, makes sure that all the
build inputs get built as well, and also can be used as a GC root.
(by applying the same trick as #95536).

The documentation has also been improved to better describe what mkShell
does and how to use it.
2022-01-08 01:54:04 +01:00
Nguyễn Gia Phong
b97ccaa18d
fetchFromSourcehut: allow recursive fetching 2022-01-03 16:37:16 +07:00
Domen Kožar
4b1c74a735
Merge pull request #145103 from symphorien/nix-env-i
doc: minimize mentions of nix-env -i without -A in nixpkgs manual
2021-12-20 10:01:20 +00:00
Guillaume Girol
a15fbab8e9 doc: minimize mentions of nix-env -i without -A in nixpkgs manual 2021-12-18 12:00:00 +00:00
Pasquale
6f0eae6d37
docs: added examples to trivial builders section 2021-12-11 19:50:03 +01:00
Robert Hensing
ddda5f28e1 dockerTools: Keep fakechroot disabled by default
Avoid risk of breaking existing images by making it opt-in.
2021-12-04 13:49:10 +00:00
Robert Hensing
0e9bc9ffd1 dockerTools: Add fakechroot to fakeRootCommands 2021-12-04 13:49:10 +00:00
Pasquale
d2e237cbe1
concatText: documentation 2021-12-02 21:54:53 +01:00
Bernardo Meurer
0e4f04b74c
writeShellApplication: buildInputs -> runtimeInputs 2021-11-08 09:33:33 -08:00
Bernardo Meurer
89979c9c5b
writeShellApplication: init 2021-11-08 09:33:32 -08:00