1
0
Fork 1
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-23 06:01:15 +00:00
nixpkgs/nixos/doc/manual
aszlig 6fec28e043
nixos-manual: Further simplify stripAnyPrefixes
First of all this fixes an evaluation error I introduced in ae466ba,
which wasn't triggered by any of my own tests against the change because
there are usually no NixOS options that are declared outside of the
<nixpkgs> tree. I renamed the attribute name from "fn" to "fileName"
first and later to "fullPath" but forgot one still occuring "filename".

Thanks to @vcunat for noticing this.

Another thing that he pointed out was that the "stripPrefix" function
can be factored away entirely, because it's very similar to
"removePrefix" in <nixpkgs/lib>.

Unfortunately we can't use "removePrefix" as is, because we need to
account for the final shlash.

So instead of removing it twice and/or retaining "stripPrefix", let's
append a shlash on every "prefixesToStrip" and we can use "removePrefix"
as is.

Tested with:

taalo-build nixos/release.nix -A tests.installer.simple.x86_64-linux

And:

w3m -dump "$(
  nix-build nixos/release.nix -A manual.x86_64-linux
)/share/doc/nixos/options.html"

Signed-off-by: aszlig <aszlig@redmoonstudios.org>
Cc: @vcunat
2016-01-29 20:14:11 +01:00
..
administration nixos-manual: fix grammar 2015-12-10 19:17:33 +01:00
configuration nixos/doc: fix to: ~/.nix-defexpr wasn't created, fixes #6606 2016-01-20 04:59:16 +01:00
development nixos: update-locatedb - harden via systemd (#7220) 2016-01-23 20:44:30 +00:00
installation nixos/manual: typo 2015-12-26 12:36:19 -06:00
release-notes nixos changelog: mention postfix changes 2016-01-21 12:48:30 +03:00
default.nix nixos-manual: Further simplify stripAnyPrefixes 2016-01-29 20:14:11 +01:00
man-configuration.xml
man-nixos-build-vms.xml
man-nixos-generate-config.xml
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

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.