tobias/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-11-14 19:58:30 +01:00
Code Issues Packages Projects Releases Wiki Activity
nixpkgs/nixos/doc/manual
History
Thomas Strobel cad8957eab Add the tool "nixos-typecheck" that can check an option declaration to: 
- Enforce that an option declaration has a "defaultText" if and only if the
   type of the option derives from "package", "packageSet" or "nixpkgsConfig"
   and if a "default" attribute is defined.

 - Enforce that the value of the "example" attribute is wrapped with "literalExample"
   if the type of the option derives from "package", "packageSet" or "nixpkgsConfig".

 - Warn if a "defaultText" is defined in an option declaration if the type of
   the option does not derive from "package", "packageSet" or "nixpkgsConfig".

 - Warn if no "type" is defined in an option declaration.
2016-02-29 01:09:00 +01:00
..
administration nixos-manual: fix grammar 2015-12-10 19:17:33 +01:00
configuration Revert "Add a way to pin a NixOS version within the module system." 2016-02-27 20:48:12 +01:00
development Add the tool "nixos-typecheck" that can check an option declaration to: 2016-02-29 01:09:00 +01:00
installation nixos/manual: typo 2015-12-26 12:36:19 -06:00
release-notes nsd service: add non-backward compatible release note entry 2016-02-28 09:18:39 +01:00
default.nix Add the tool "nixos-typecheck" that can check an option declaration to: 2016-02-29 01:09:00 +01:00
man-configuration.xml
man-nixos-build-vms.xml
man-nixos-generate-config.xml filesystems: use list of strings for fs options 2016-02-06 19:48:30 +00:00
man-nixos-install.xml nixos-install: support -j, --cores and --option. Closes #6755 2015-03-11 16:47:44 +00:00
man-nixos-option.xml nixos-option: fixes as suggested by @nbp 2014-09-06 20:59:14 +02:00
man-nixos-rebuild.xml nixos-rebuild: Document --build-host and --target-host options 2016-01-01 18:22:11 +01:00
man-pages.xml document options to nixos-install script 2015-01-06 14:49:24 +01:00
manual.xml Move release notes to an appendix and a separate chunk 2015-07-22 16:21:32 +02:00
options-to-docbook.xsl Manual: Don't render types as strings 2015-07-30 13:44:54 +02:00
README nixos/doc/manual: Fix typos in README. 2014-07-23 15:00:25 +02:00
style.css Manual: Chunk into separate pages 2014-08-25 19:08:31 +02:00

README 

To build the manual, you need Nix installed on your system (no need
for NixOS). To install Nix, follow the instructions at

    https://nixos.org/nix/download.html

When you have Nix on your system, in the root directory of the project
(i.e., `nixpkgs`), run:

    nix-build nixos/release.nix -A manual.x86_64-linux

When this command successfully finishes, it will tell you where the
manual got generated.