Silvan Mosberger
d5a2922641
nixos/doc: Note that attrsOf is strict in its values
2020-01-10 16:19:54 +01:00
Silvan Mosberger
e9c16ec186
Merge pull request #76857 from Infinisil/recursive-disableModules
...
Apply `disabledModules` recursively
2020-01-09 18:20:12 +01:00
Silvan Mosberger
a6462a4a8b
nixos/doc: Extend disabledModules docs to indicate recursive disabling
2020-01-09 17:26:08 +01:00
Silvan Mosberger
6525da6321
lib/types: Allow paths as submodule values
2020-01-08 23:54:45 +01:00
Silvan Mosberger
c7ade6844f
Revert "lib/types: Allow paths as submodule values"
...
This reverts commit eec83d41e3
.
This broke hydra evaluation because with this commit submodule values
are allowed to be paths, however the certmgr module uses `either
(submodule ...) path` in its type, meaning it already used paths for
something else which would now be interpreted as a submodule.
2020-01-03 05:21:01 +01:00
Silvan Mosberger
cdf79db19d
Module system improvements for NixOS as a submodule ( #75031 )
...
Module system improvements for NixOS as a submodule
2020-01-02 20:38:45 +01:00
Silvan Mosberger
eec83d41e3
lib/types: Allow paths as submodule values
2020-01-02 09:59:35 +01:00
Silvan Mosberger
90c82bfee7
nixos/docs: Add docs for types.submoduleWith
2020-01-02 09:59:32 +01:00
Maximilian Bosch
b72661749b
nixos/python-test-driver: add an option to disable python linter
...
While it's a good idea to automate the linting of the python code used
for our tests, I think that it can be quite distracting when hacking on
a NixOS test.
I figured that it might be more convenient to add an option as a
shortcut for this to avoid that everyone needs to dig into the test
driver again.
2019-12-22 19:27:43 +01:00
Vladimír Čunát
e32d557967
Merge #45957 : nixos manual: releases workflow improvements
...
Let's merge NOW; I'm not doing the same mistake again.
2019-11-20 13:31:24 +01:00
Vladimír Čunát
be6e0bf5c3
nixos manual: releases workflow nitpicks
...
Co-Authored-By: asymmetric <lorenzo@mailbox.org>
2019-11-20 13:29:06 +01:00
Tom F
a21cb75242
nixos/manual: fix IDs on docs for running tests ( #73526 )
2019-11-17 11:47:28 +01:00
worldofpeace
3d256326ab
nixos/doc: remove refs to slim
2019-11-11 17:10:41 -05:00
Jacek Galowicz
7d19c5aaa7
nixos/test: Pythonify documentation
2019-11-04 23:50:50 +01:00
Vladimír Čunát
d9c5d584cd
Merge branch 'master' into release-docs
...
It's been a very long time, so I think a merge will be better than
a rebase. There was only one simple conflict.
2019-10-27 10:29:58 +01:00
Eelco Dolstra
5b324c1825
Remove references to the nixpkgs-channels repo
...
Channel branches are now provided in the nixpkgs repo.
Issue #71176 .
2019-10-17 19:44:03 +02:00
Eelco Dolstra
b0ccd6dd16
Revert "nixos/doc: re-format"
...
This reverts commit ea6e8775bd
. The new
format is not an improvement.
2019-09-19 19:17:30 +02:00
Jan Tojnar
ea6e8775bd
nixos/doc: re-format
2019-09-18 22:13:35 +02:00
Samuel Leathers
bb1b96373b
nixos docs: add release manager section
2019-08-23 10:10:12 -04:00
Aaron Andersen
6f6468bef3
Merge pull request #65728 from Infinisil/types-eithers
...
lib/types: Add oneOf, extension of either to a list of types
2019-08-13 11:48:42 -04:00
Silvan Mosberger
9a44f44d4c
lib/types: Add oneOf, extension of either to a list of types
2019-08-06 14:08:42 +02:00
Léo Gaspard
6a2abeb6b4
Update nixos/doc/manual/development/releases.xml
...
Co-Authored-By: Alyssa Ross <hi@alyssa.is>
2019-06-24 18:57:24 +02:00
Léo Gaspard
980b5e0c88
manual: remind to drop kernels that will get EOL'd
2019-06-24 17:11:54 +02:00
Jan Tojnar
a3f2131eb6
doc: Use prompt more often
2019-06-17 13:25:50 +02:00
Jan Tojnar
11cb382a4c
nixos/doc: Fix spurious indentation
2019-06-17 12:28:26 +02:00
Matthew O'Gorman
da035d3ad6
nixos/manual: update 17.03 -> 19.03 in upgrading section
2019-04-12 12:16:30 -04:00
Andreas Rammhold
c55427ca43
nixos/doc: add types
prefix to addCheck
example
...
The function `addCheck` resides within the attrset `types`. We should be
explicit about this since otherwise people might be confused where it
does come from / why it doesn't work for them.
2019-03-11 22:56:56 +01:00
Graham Christensen
777e94d903
Merge pull request #55436 from layus/warn-manual-ids
...
Nixos manual: error out on missing IDs
2019-03-09 08:21:07 -05:00
Domen Kožar
0fd85a1f99
nixos release: there's a wildcard protection now for release-* on github
2019-02-26 14:12:46 +07:00
Guillaume Maudoux
473a3ef606
nixos/manual: add dummy ids to silence warnings
2019-02-08 10:23:57 +01:00
Samuel Dionne-Riel
3aab228d09
Revert "Add ssh backdoor to VM tests infrastructure."
...
This reverts commit d6e3db44cf
.
See #53935 for explanations. In short, it may be causing issues with
tests on the build infrastructure.
2019-01-19 13:24:39 -05:00
Erik Arvstedt
931b7b47a2
nixos tests doc: minor fixes
...
This fixes some quirks I introduced in previous commits.
1. No need for an extra newline when printing the output of shell commands.
2. 'or die' is what's already used in the NixOS test sources, while
'die unless' has no occurrences.
2018-11-26 19:36:50 +01:00
Daniel Rutz
0885a65169
nixos/doc: Add documentation for types.port type
2018-10-19 12:33:24 +02:00
Samuel Dionne-Riel
4f43e5fe88
fixup ^ release improvements.
2018-10-05 19:34:52 -04:00
Vladimír Čunát
dd82f6cec0
nixos manual: releases workflow improvements
...
- `git push --tags` is too dangerous (pushes all your tags)
2018-10-05 19:34:52 -04:00
Graham Christensen
8413f22bb3
docs: format
2018-09-29 20:51:11 -04:00
Tuomas Tynkkynen
d6e3db44cf
Add ssh backdoor to VM tests infrastructure.
...
Thanks to @dezgeg for prototype implementation, I've
cleaned it up and added documentation.
2018-09-28 10:53:08 +01:00
Jan Malakhovski
fe744d3fb1
nixos: doc: rename manual
to manualHTML
, cleanup references
...
Because when I see "config.system.build.manual.manual" after I forgot
what it means I ask "Why do I need that second `.manual` there again?".
Doesn't happen with `config.system.build.manual.manualHTML`.
2018-09-23 20:47:58 +00:00
Erik Arvstedt
a91330a41b
nixos tests doc: update VM state path
2018-09-17 15:02:58 +02:00
Erik Arvstedt
6e203af399
nixos tests doc: add example statement
2018-09-17 13:08:08 +02:00
Erik Arvstedt
b0956b0ae3
nixos tests doc: fix example statement
...
False statements don't cause NixOS tests to fail, we need to throw an
exception or terminate.
2018-09-17 13:08:02 +02:00
Graham Christensen
ff23dd110b
nixos docs: more IDs
2018-09-02 15:47:59 -04:00
Graham Christensen
18fd616351
nixos docs: Give sections IDs
2018-09-01 16:20:49 -04:00
Matthew Harm Bekkema
a6c7132abc
doc: change git:// links to https:// ( #44395 )
...
The server is not verified over the git:// transfer protocol. If you
clone a repository over git://, you should check if the latest commit's
hash is correct.
On the other hand, https:// will always verify the server automatically,
using certificate authorities.
2018-08-03 14:01:34 +01:00
Tuomas Tynkkynen
96190535e5
Revert "nixos: rename system.{stateVersion,defaultChannel} -> system.nixos.\1"
...
This reverts commit 095fe5b43d
.
Pointless renames considered harmful. All they do is force people to
spend extra work updating their configs for no benefit, and hindering
the ability to switch between unstable and stable versions of NixOS.
Like, what was the value of having the "nixos." there? I mean, by
definition anything in a NixOS module has something to do with NixOS...
2018-07-28 00:12:55 +03:00
Samuel Dionne-Riel
15fa70cd78
nixos/doc+man: Fixes squishedtogether definitions.
2018-05-31 21:07:15 -04:00
Samuel Dionne-Riel
88ca2b1ec4
nixos/doc: ran make format
...
With visual inspection that nothing got worse.
2018-05-31 21:03:51 -04:00
Jan Malakhovski
095fe5b43d
nixos: rename system.{stateVersion,defaultChannel} -> system.nixos.\1
2018-05-12 19:27:09 +00:00
Niklas Hambüchen
6e7f4f99d1
manual: Document types.attrs
...
Signed-off-by: Niklas Hambüchen <mail@nh2.me>
2018-05-07 00:36:39 +02:00
Graham Christensen
eca5c99bf8
nixos docs: format =)
2018-05-01 19:57:09 -04:00
Graham Christensen
74fcb1c770
nixos docs: include note about make for debugging the nixos docs
2018-04-28 04:15:16 -04:00
Graham Christensen
68d48cecf6
Merge pull request #31418 from ryantm/doc-nixos-extra-module-path
...
lib/eval-config: document NIXOS_EXTRA_MODULE_PATH
2018-04-27 21:26:06 -04:00
Richard Marko
d5de7bbc92
nixos manual: fix (n)of typo
2018-03-18 09:00:35 +01:00
Ryan Mulligan
1cc97befd5
lib/eval-config: document NIXOS_EXTRA_MODULE_PATH
...
This adds some documentation about importing modules external to
Nixpkgs, which provides context for documenting
NIXOS_EXTRA_MODULE_PATH.
Closes #30376
2018-02-20 07:25:33 -08:00
Eelco Dolstra
e88f28965a
nixos-install: Make compatible with Nix 2.0
...
The use of Nix 2.0 significantly simplifies the installer, since we
can just pass a different store URI (--store /mnt) - it's no longer
needed to set up a chroot environment for the build, and to bootstrap
Nix into the chroot.
Also, commands that need to run in the installation (namely boot
loader installation and setting a root password) are now executed
using nixos-enter.
This also removes the need for nixos-prepare-root since any required
initialisation is done by Nix or by the activation script.
2018-02-05 19:50:36 +01:00
Maximilian Bosch
e18b0b6033
test-driver: mention $user
argument in the NixOS manual and the Impala release notes
2018-01-06 10:09:18 +01:00
Yegor Timoshenko
108f76c927
Merge pull request #31668 from rycee/doc/naming
...
docs: clarify package and module option naming
2017-12-23 17:12:29 +03:00
Ryan Trinkle
83048c4fe0
nixpkgs.lib: Add types.strMatching
2017-12-02 13:28:00 -05:00
Bastian Köcher
1200f9b9e2
Adds missing documentation for copyFileFromHost in NixOS tests
2017-11-23 15:50:54 +01:00
Robert Helgesson
91154416b6
docs: clarify package and module option naming
...
This attempts to briefly clarify the current naming conventions of
attribute names in `all-packages.nix` and module option names.
2017-11-14 19:17:35 +01:00
Profpatsch
462c048c77
lib/types: add ints.positive
.
...
For values that are positive, but cannot be 0.
2017-11-05 15:56:32 +01:00
Profpatsch
c85f085062
lib/types: update docs to match the new type names
2017-11-05 15:56:32 +01:00
Profpatsch
3e3bfc66f7
lib/types: nixos manual documentation for signed/unsinged int
...
Synchronize the manual for the new types.
2017-11-05 15:56:32 +01:00
Profpatsch
c53d874277
lib/types: add intBetween
...
An int type that checks the value range.
2017-11-05 15:56:32 +01:00
Robert
1b1fc65505
NixOS Manual: document assertions and warnings ( #29206 )
...
* NixOS Manual: document assertions and warnings
* NixOS manual: re-wrap assertions text
2017-09-11 17:12:50 +01:00
Thomas Bach
4d101993bf
manual: reworked submodule section for better readability
...
The section was strange to read, as the initial example already used
`listOf' which is mentioned in the very first paragraph. Then you read
in a subsection about `listOf' and the exact same example is given
once again.
2017-09-10 20:51:50 +02:00
Thomas Bach
f37a1e155e
manual: fixed remaining placeholder literal
2017-09-10 20:51:50 +02:00
Thomas Bach
572726a570
manual: name' is not an argument for
mkOption'
2017-09-10 20:51:50 +02:00
Franz Pletz
6a7066eb53
release documentation: reorder beta steps
2017-08-30 22:51:32 +02:00
Robin Gloster
de31f879bd
release documentation: update to current procedure
2017-08-30 22:24:34 +02:00
Jan Tojnar
e35f3c0679
doc: Fix some typos
2017-06-11 22:13:42 +02:00
Emmanuel Rosa
4bee34dcc5
doc: clarify building-nixos CD/DVD instructions
...
This change updates the instructions for building a NixOS ISO so that it's clear how to do it.
Previously, the instructions stated to set NIXOS_CONFIG prior to running `nix-build`, yet the example provided by-passed NIXOS_CONFIG anyway. But the *really* important missing piece is the need for nixos/default.nix. See #21840 .
This change removes the NIXOS_CONFIG verbiage, and adds steps to clone nixpkgs and (most importantly) cd'ing into nixpkgs/nixos. That way, the reader may think: *Oh, so I need a default.nix and a configuration.nix. Ahhh, OK.*
I purposely added the redundant default.nix argument.
2017-06-02 21:13:19 -04:00
Nikolay Amiantov
ee4f8c2dc9
nixos doc: document coercedTo type
...
Also mention about docs in types.nix and fix a small error in related
documentation.
Fixes #26055 .
2017-05-24 15:52:26 +03:00
Niklas Hambüchen
2df7d4d63a
manual: Fix addCheck
example having arguments in wrong order.
...
`addCheck` takes first the type, then the check.
2017-05-21 15:03:16 +02:00
Niklas Hambüchen
aed1986f2f
Fix typo about options without defaults
2017-05-20 17:05:02 +02:00
Théo Zimmermann
72070e6dfc
doc: improve "getting the sources" chapter
2017-04-01 17:56:29 +02:00
Christine Koppelt
e5c927cb8d
NixOS Manual: Update version numbers
2017-03-25 20:14:04 +01:00
Daiderd Jordan
d88721e440
modules: add support for module replacement with disabledModules
...
This is based on a prototype Nicolas B. Pierron worked on during a
discussion we had at FOSDEM.
A new version with a workaround for problems of the reverted original.
Discussion: https://github.com/NixOS/nixpkgs/commit/3f2566689
2017-03-03 13:45:22 +01:00
Vladimír Čunát
fcec3e1c72
Revert "modules: add support for module replacement with disabledModules"
...
This reverts commit 3f2566689d
for now.
Evaluation of the tested job got broken, blocking nixos-unstable.
2017-03-01 21:56:01 +01:00
Daiderd Jordan
3f2566689d
modules: add support for module replacement with disabledModules
...
This is based on a prototype Nicolas B. Pierron worked on during a
discussion we had at FOSDEM.
2017-02-28 00:14:48 +01:00
Graham Christensen
d9ab783f58
nixos manual: correct reference to sddm
2017-02-10 22:52:08 -05:00
Graham Christensen
b12564cc1b
nixos: update default cases from KDM/KDE4 to SDDM/KDE5
2017-02-09 21:52:00 -05:00
Eric Sagnes
2b1d67a275
manual: reviewing contributions nixos -> nixpkgs ( #20626 )
2016-11-22 15:15:02 +01:00
Eric Sagnes
e14de56613
module system: extensible option types
2016-11-06 00:05:58 +01:00
Eric Sagnes
1fe1cdecb2
types: loeOf -> listOf
2016-11-05 21:46:42 +01:00
Jörg Thalheim
da5c0220aa
Merge pull request #17622 from rvl/nixos-manual-writing-documentation
...
Add documentation about writing NixOS documentation
2016-10-09 13:39:08 +02:00
Pascal Bach
8c053633df
Fix xml validation error in NixOS releases documentation
2016-10-07 22:49:05 +02:00
Domen Kožar
ed6ea7416a
Document NixOS release process #4442
2016-10-07 09:49:47 +02:00
Alexander Ried
0a0347c589
reviewing-contributions.xml: fix typo
2016-10-05 10:40:32 +02:00
Eric Sagnes
caef192c81
nixos-manual: reviewing chapter cleanup
2016-10-02 00:50:16 +09:00
Eric Sagnes
bf86f9f016
improvements from feedback 2
2016-10-01 19:02:09 +09:00
Eric Sagnes
7ad26bdc6e
improvements from feedback
2016-09-28 11:05:22 +09:00
Eric Sagnes
3504a546e6
[WIP] typo fixes, few improvements
2016-09-27 00:36:59 +09:00
Eric Sagnes
8d656d2ca0
nixos-doc: add reviewing-contributions
2016-09-26 15:44:06 +09:00
Eric Sagnes
b32252ddfa
NixOS manual: add module option types doc ( #18525 )
2016-09-13 07:04:02 +02:00
Rodney Lorrimar
4908d7bf20
nixos-manual: Add a chapter about writing documentation
...
It's more about the practical side of DocBook-wrangling than anything
else.
2016-09-11 13:21:09 +01:00
Robin Gloster
6808de76e6
nixos doc: module meta attribute section cleanup
2016-08-29 09:34:24 +00:00
Eric Sagnes
aa8e663b6e
nixos doc: add modules meta-attributes ( #18078 )
2016-08-29 07:54:25 +00:00
Wilhelm Schuster
5f8d14546b
Manual: Explicitly mark commands that require to be run as root ( #15589 )
...
* manual: Mark commands that require root
Mark every command that requires to be run as root by prefixing them
with '#' instead of '$'.
* manual: Add note about commands that require root
2016-06-01 15:23:32 +01:00
Joachim Fasting
d9796f44f6
manual: minor cleanups
2016-05-22 20:01:52 +02:00