Commit graph

67 commits

Author SHA1 Message Date
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