nixpkgs/nixos/doc/manual
Samuel Dionne-Riel bc0421c4cf doc: Adds xml fixing script. (see previous and next commits)
This script is used to automatically fix issues within xml documentation
files.

The script is *for now* intended to be used ad-hoc, and the commits to
be examined.

A future discussion will define whether:

  * This commit and scripts are kept.
  * The script is extended for common use.

The biggest issue right now with the script is that it *could* in theory
destroy a valid space-less varlistentry.

The script could, in practical use, be changed and extended to normalize
some parts of the XML files, mainly:

  * A common quoting style for attributes
  * Fix-up some weird formatting automatically that xmlformat doesn't
    catch
2018-05-31 21:02:15 -04:00
..
administration nixos docs: format =) 2018-05-01 19:57:09 -04:00
configuration nixos: Fix build of the manual 2018-05-15 14:54:57 +02:00
development nixos: rename system.{stateVersion,defaultChannel} -> system.nixos.\1 2018-05-12 19:27:09 +00:00
installation minor improvement to nix installation instructions (#40521) 2018-05-16 00:23:00 -05:00
release-notes Kubernetes: 2018-05-26 11:19:12 +02:00
.gitignore nixos docs: ignore generated files 2018-05-01 19:50:02 -04:00
default.nix nixos docs: Add a makefile for hacking on the nixos docs 2018-04-28 04:00:55 -04:00
Makefile doc: Adds xml fixing script. (see previous and next commits) 2018-05-31 21:02:15 -04:00
man-configuration.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
man-nixos-build-vms.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
man-nixos-enter.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
man-nixos-generate-config.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
man-nixos-install.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
man-nixos-option.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
man-nixos-rebuild.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
man-nixos-version.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
man-pages.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
manual.xml nixos docs: format =) 2018-05-01 19:57:09 -04:00
options-to-docbook.xsl nixos docs: Add a makefile for hacking on the nixos docs 2018-04-28 04:00:55 -04:00
README nixos/doc/manual: Fix typos in README. 2014-07-23 15:00:25 +02:00
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.