nixpkgs/nixos/doc/manual
aszlig 4652f2f87e
nixos: Document option description changes
This adds a release notes entry to make users (and especially
developers) aware so they no longer need to use </para><para> in option
descriptions as this is now done automatically on every two consecutive
newlines.

More details can be found in the commit message of f865d0feab.

Signed-off-by: aszlig <aszlig@nix.build>
2018-09-03 01:14:46 +02:00
..
administration Document running nixos-rebuild switch to clear /boot space 2018-08-31 21:37:07 -04:00
configuration nixos docs: more IDs 2018-09-02 15:47:59 -04:00
development nixos docs: more IDs 2018-09-02 15:47:59 -04:00
installation nixos docs: Give sections IDs 2018-09-01 16:20:49 -04:00
release-notes nixos: Document option description changes 2018-09-03 01:14:46 +02:00
.gitignore
default.nix nixos: Split paras by \n\n in option descriptions 2018-09-02 08:10:37 +02:00
Makefile makefile: auto-format xml docs outside of the doc subdir 2018-09-01 16:20:49 -04:00
man-configuration.xml
man-nixos-build-vms.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-nixos-enter.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-nixos-generate-config.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-nixos-install.xml nixos/doc+man: Fixes squishedtogether definitions. 2018-05-31 21:07:15 -04:00
man-nixos-option.xml nixos/doc+man: Fixes squishedtogether definitions. 2018-05-31 21:07:15 -04:00
man-nixos-rebuild.xml nixos/doc+man: Fixes squishedtogether definitions. 2018-05-31 21:07:15 -04:00
man-nixos-version.xml nixos/doc: ran make format 2018-05-31 21:03:51 -04:00
man-pages.xml
manual.xml nixos docs: give IDs to things 2018-09-01 16:20:49 -04:00
options-to-docbook.xsl nixos: Split paras by \n\n in option descriptions 2018-09-02 08:10:37 +02:00
postprocess-option-descriptions.xsl nixos: Split paras by \n\n in option descriptions 2018-09-02 08:10:37 +02:00
README
shell.nix doc: Adds xml fixing script. (see previous and next commits) 2018-05-31 21:02:15 -04:00

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.