diff --git a/doc/Makefile b/doc/Makefile index 8a4612e95f19..ba77be6678c4 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -12,6 +12,11 @@ format: find . -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \ xmlformat --config-file "$$XMLFORMAT_CONFIG" -i {} +.PHONY: fix-misc-xml +fix-misc-xml: + find . -iname '*.xml' -type f \ + -exec ../nixos/doc/varlistentry-fixer.rb {} ';' + .PHONY: clean clean: rm -f ${MD_TARGETS} .version manual-full.xml diff --git a/doc/coding-conventions.xml b/doc/coding-conventions.xml index f244c11d4f20..b3f7f093835c 100644 --- a/doc/coding-conventions.xml +++ b/doc/coding-conventions.xml @@ -312,11 +312,15 @@ args.stdenv.mkDerivation (args // { - If it’s used to support software development: + + If it’s used to support software development: + - If it’s a library used by other packages: + + If it’s a library used by other packages: + development/libraries (e.g. @@ -325,7 +329,9 @@ args.stdenv.mkDerivation (args // { - If it’s a compiler: + + If it’s a compiler: + development/compilers (e.g. @@ -334,7 +340,9 @@ args.stdenv.mkDerivation (args // { - If it’s an interpreter: + + If it’s an interpreter: + development/interpreters (e.g. @@ -343,11 +351,15 @@ args.stdenv.mkDerivation (args // { - If it’s a (set of) development tool(s): + + If it’s a (set of) development tool(s): + - If it’s a parser generator (including lexers): + + If it’s a parser generator (including lexers): + development/tools/parsing (e.g. @@ -356,7 +368,9 @@ args.stdenv.mkDerivation (args // { - If it’s a build manager: + + If it’s a build manager: + development/tools/build-managers (e.g. @@ -365,7 +379,9 @@ args.stdenv.mkDerivation (args // { - Else: + + Else: + development/tools/misc (e.g. @@ -377,7 +393,9 @@ args.stdenv.mkDerivation (args // { - Else: + + Else: + development/misc @@ -388,7 +406,9 @@ args.stdenv.mkDerivation (args // { - If it’s a (set of) tool(s): + + If it’s a (set of) tool(s): + (A tool is a relatively small program, especially one intended to be @@ -396,7 +416,9 @@ args.stdenv.mkDerivation (args // { - If it’s for networking: + + If it’s for networking: + tools/networking (e.g. @@ -405,7 +427,9 @@ args.stdenv.mkDerivation (args // { - If it’s for text processing: + + If it’s for text processing: + tools/text (e.g. diffutils) @@ -413,9 +437,9 @@ args.stdenv.mkDerivation (args // { - If it’s a system utility, i.e., - something related or essential to the operation of a - system: + + If it’s a system utility, i.e., something related or essential to the operation of a system: + tools/system (e.g. cron) @@ -423,8 +447,9 @@ args.stdenv.mkDerivation (args // { - If it’s an archiver (which may - include a compression function): + + If it’s an archiver (which may include a compression function): + tools/archivers (e.g. zip, @@ -433,7 +458,9 @@ args.stdenv.mkDerivation (args // { - If it’s a compression program: + + If it’s a compression program: + tools/compression (e.g. @@ -442,7 +469,9 @@ args.stdenv.mkDerivation (args // { - If it’s a security-related program: + + If it’s a security-related program: + tools/security (e.g. nmap, @@ -451,7 +480,9 @@ args.stdenv.mkDerivation (args // { - Else: + + Else: + tools/misc @@ -462,7 +493,9 @@ args.stdenv.mkDerivation (args // { - If it’s a shell: + + If it’s a shell: + shells (e.g. bash) @@ -470,11 +503,15 @@ args.stdenv.mkDerivation (args // { - If it’s a server: + + If it’s a server: + - If it’s a web server: + + If it’s a web server: + servers/http (e.g. @@ -483,7 +520,9 @@ args.stdenv.mkDerivation (args // { - If it’s an implementation of the X Windowing System: + + If it’s an implementation of the X Windowing System: + servers/x11 (e.g. xorg — @@ -492,7 +531,9 @@ args.stdenv.mkDerivation (args // { - Else: + + Else: + servers/misc @@ -503,7 +544,9 @@ args.stdenv.mkDerivation (args // { - If it’s a desktop environment: + + If it’s a desktop environment: + desktops (e.g. kde, @@ -512,7 +555,9 @@ args.stdenv.mkDerivation (args // { - If it’s a window manager: + + If it’s a window manager: + applications/window-managers (e.g. @@ -521,7 +566,9 @@ args.stdenv.mkDerivation (args // { - If it’s an application: + + If it’s an application: + A (typically large) program with a distinct user interface, primarily @@ -529,7 +576,9 @@ args.stdenv.mkDerivation (args // { - If it’s a version management system: + + If it’s a version management system: + applications/version-management (e.g. @@ -538,7 +587,9 @@ args.stdenv.mkDerivation (args // { - If it’s for video playback / editing: + + If it’s for video playback / editing: + applications/video (e.g. @@ -547,7 +598,9 @@ args.stdenv.mkDerivation (args // { - If it’s for graphics viewing / editing: + + If it’s for graphics viewing / editing: + applications/graphics (e.g. @@ -556,11 +609,15 @@ args.stdenv.mkDerivation (args // { - If it’s for networking: + + If it’s for networking: + - If it’s a mailreader: + + If it’s a mailreader: + applications/networking/mailreaders (e.g. @@ -569,7 +626,9 @@ args.stdenv.mkDerivation (args // { - If it’s a newsreader: + + If it’s a newsreader: + applications/networking/newsreaders (e.g. @@ -578,7 +637,9 @@ args.stdenv.mkDerivation (args // { - If it’s a web browser: + + If it’s a web browser: + applications/networking/browsers (e.g. @@ -587,7 +648,9 @@ args.stdenv.mkDerivation (args // { - Else: + + Else: + applications/networking/misc @@ -598,7 +661,9 @@ args.stdenv.mkDerivation (args // { - Else: + + Else: + applications/misc @@ -609,12 +674,15 @@ args.stdenv.mkDerivation (args // { - If it’s data (i.e., does not have a - straight-forward executable semantics): + + If it’s data (i.e., does not have a straight-forward executable semantics): + - If it’s a font: + + If it’s a font: + data/fonts @@ -622,11 +690,15 @@ args.stdenv.mkDerivation (args // { - If it’s related to SGML/XML processing: + + If it’s related to SGML/XML processing: + - If it’s an XML DTD: + + If it’s an XML DTD: + data/sgml+xml/schemas/xml-dtd (e.g. @@ -635,7 +707,9 @@ args.stdenv.mkDerivation (args // { - If it’s an XSLT stylesheet: + + If it’s an XSLT stylesheet: + (Okay, these are executable...) @@ -653,7 +727,9 @@ args.stdenv.mkDerivation (args // { - If it’s a game: + + If it’s a game: + games @@ -661,7 +737,9 @@ args.stdenv.mkDerivation (args // { - Else: + + Else: + misc diff --git a/doc/cross-compilation.xml b/doc/cross-compilation.xml index fe0e0d88d30e..3b433fdcc1d2 100644 --- a/doc/cross-compilation.xml +++ b/doc/cross-compilation.xml @@ -60,7 +60,8 @@ - buildPlatform + + buildPlatform @@ -71,7 +72,8 @@ - hostPlatform + + hostPlatform @@ -82,7 +84,8 @@ - targetPlatform + + targetPlatform @@ -128,7 +131,8 @@ - system + + system @@ -141,7 +145,8 @@ - config + + config @@ -157,7 +162,8 @@ - parsed + + parsed @@ -171,7 +177,8 @@ - libc + + libc @@ -183,7 +190,8 @@ - is* + + is* @@ -195,7 +203,8 @@ - platform + + platform diff --git a/doc/functions.xml b/doc/functions.xml index cdae96703f13..746ef7131f86 100644 --- a/doc/functions.xml +++ b/doc/functions.xml @@ -321,7 +321,8 @@ merge:"diff3" - name + + name @@ -330,7 +331,8 @@ merge:"diff3" - targetPkgs + + targetPkgs @@ -340,7 +342,8 @@ merge:"diff3" - multiPkgs + + multiPkgs @@ -351,7 +354,8 @@ merge:"diff3" - extraBuildCommands + + extraBuildCommands @@ -361,7 +365,8 @@ merge:"diff3" - extraBuildCommandsMulti + + extraBuildCommandsMulti @@ -371,7 +376,8 @@ merge:"diff3" - extraOutputsToInstall + + extraOutputsToInstall @@ -381,7 +387,8 @@ merge:"diff3" - extraInstallCommands + + extraInstallCommands @@ -391,7 +398,8 @@ merge:"diff3" - runScript + + runScript @@ -624,9 +632,9 @@ merge:"diff3" This function is analogous to the docker pull command, - in that can be used to pull a Docker image from a Docker registry. - By default Docker Hub - is used to pull images. + in that can be used to pull a Docker image from a Docker registry. By + default Docker Hub is + used to pull images. @@ -648,15 +656,15 @@ merge:"diff3" - imageName specifies the name of the image to be downloaded, - which can also include the registry namespace (e.g. nixos). - This argument is required. + imageName specifies the name of the image to be + downloaded, which can also include the registry namespace (e.g. + nixos). This argument is required. - imageDigest specifies the digest of the image - to be downloaded. Skopeo can be used to get the digest of an image + imageDigest specifies the digest of the image to be + downloaded. Skopeo can be used to get the digest of an image $ skopeo inspect docker://docker.io/nixos/nix:1.11 | jq -r '.Digest' sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b @@ -666,10 +674,10 @@ merge:"diff3" - finalImageTag, if specified, this is the tag of - the image to be created. Note it is never used to fetch the image - since we prefer to rely on the immutable digest ID. By default - it's latest. + finalImageTag, if specified, this is the tag of the + image to be created. Note it is never used to fetch the image since we + prefer to rely on the immutable digest ID. By default it's + latest. diff --git a/doc/languages-frameworks/bower.xml b/doc/languages-frameworks/bower.xml index db7536cdc14e..118f6e10473a 100644 --- a/doc/languages-frameworks/bower.xml +++ b/doc/languages-frameworks/bower.xml @@ -205,8 +205,8 @@ pkgs.stdenv.mkDerivation { - ENOCACHE errors from - buildBowerComponents + + ENOCACHE errors from buildBowerComponents diff --git a/doc/meta.xml b/doc/meta.xml index ab6befd4381c..496b32916552 100644 --- a/doc/meta.xml +++ b/doc/meta.xml @@ -83,7 +83,8 @@ hello-2.3 A program that produces a familiar, friendly greeting - description + + description @@ -106,7 +107,8 @@ hello-2.3 A program that produces a familiar, friendly greeting - longDescription + + longDescription @@ -115,7 +117,8 @@ hello-2.3 A program that produces a familiar, friendly greeting - branch + + branch @@ -126,7 +129,8 @@ hello-2.3 A program that produces a familiar, friendly greeting - homepage + + homepage @@ -136,7 +140,8 @@ hello-2.3 A program that produces a familiar, friendly greeting - downloadPage + + downloadPage @@ -146,7 +151,8 @@ hello-2.3 A program that produces a familiar, friendly greeting - license + + license @@ -198,7 +204,8 @@ hello-2.3 A program that produces a familiar, friendly greeting - maintainers + + maintainers @@ -213,7 +220,8 @@ hello-2.3 A program that produces a familiar, friendly greeting - priority + + priority @@ -225,7 +233,8 @@ hello-2.3 A program that produces a familiar, friendly greeting - platforms + + platforms @@ -242,7 +251,8 @@ meta.platforms = stdenv.lib.platforms.linux; - hydraPlatforms + + hydraPlatforms @@ -261,7 +271,8 @@ meta.hydraPlatforms = []; - broken + + broken @@ -273,7 +284,8 @@ meta.hydraPlatforms = []; - updateWalker + + updateWalker @@ -305,8 +317,8 @@ meta.hydraPlatforms = []; generic options are available: - stdenv.lib.licenses.free, - "free" + + stdenv.lib.licenses.free, "free" @@ -315,8 +327,8 @@ meta.hydraPlatforms = []; - stdenv.lib.licenses.unfreeRedistributable, - "unfree-redistributable" + + stdenv.lib.licenses.unfreeRedistributable, "unfree-redistributable" @@ -336,8 +348,8 @@ meta.hydraPlatforms = []; - stdenv.lib.licenses.unfree, - "unfree" + + stdenv.lib.licenses.unfree, "unfree" @@ -348,8 +360,8 @@ meta.hydraPlatforms = []; - stdenv.lib.licenses.unfreeRedistributableFirmware, - "unfree-redistributable-firmware" + + stdenv.lib.licenses.unfreeRedistributableFirmware, "unfree-redistributable-firmware" diff --git a/doc/multiple-output.xml b/doc/multiple-output.xml index 040c12c92913..981b4b966cdf 100644 --- a/doc/multiple-output.xml +++ b/doc/multiple-output.xml @@ -188,8 +188,8 @@ - - $outputDev + + $outputDev @@ -200,8 +200,8 @@ - - $outputBin + + $outputBin @@ -211,8 +211,8 @@ - - $outputLib + + $outputLib @@ -223,8 +223,8 @@ - - $outputDoc + + $outputDoc @@ -235,8 +235,8 @@ - - $outputDevdoc + + $outputDevdoc @@ -248,8 +248,8 @@ - - $outputMan + + $outputMan @@ -259,8 +259,8 @@ - - $outputDevman + + $outputDevman @@ -270,8 +270,8 @@ - - $outputInfo + + $outputInfo diff --git a/doc/package-notes.xml b/doc/package-notes.xml index f16826ae6806..a6347bfdebaf 100644 --- a/doc/package-notes.xml +++ b/doc/package-notes.xml @@ -428,7 +428,9 @@ packageOverrides = pkgs: { - Steam fails to start. What do I do? + + Steam fails to start. What do I do? + Try to run @@ -438,7 +440,9 @@ packageOverrides = pkgs: { - Using the FOSS Radeon or nouveau (nvidia) drivers + + Using the FOSS Radeon or nouveau (nvidia) drivers + @@ -462,7 +466,9 @@ packageOverrides = pkgs: { - Java + + Java + diff --git a/doc/shell.nix b/doc/shell.nix index e8da2eaf16be..24fe20e81050 100644 --- a/doc/shell.nix +++ b/doc/shell.nix @@ -1,5 +1,5 @@ { pkgs ? import ../. {} }: (import ./default.nix).overrideAttrs (x: { - buildInputs = x.buildInputs ++ [ pkgs.xmloscopy ]; + buildInputs = x.buildInputs ++ [ pkgs.xmloscopy pkgs.ruby ]; }) diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 78fa1d209b58..e7f52377e687 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -361,7 +361,8 @@ let f(h, h + 1, i) = i + h Variables specifying dependencies - depsBuildBuild + + depsBuildBuild @@ -386,7 +387,8 @@ let f(h, h + 1, i) = i + h - nativeBuildInputs + + nativeBuildInputs @@ -412,7 +414,8 @@ let f(h, h + 1, i) = i + h - depsBuildTarget + + depsBuildTarget @@ -451,7 +454,8 @@ let f(h, h + 1, i) = i + h - depsHostHost + + depsHostHost @@ -469,7 +473,8 @@ let f(h, h + 1, i) = i + h - buildInputs + + buildInputs @@ -492,7 +497,8 @@ let f(h, h + 1, i) = i + h - depsTargetTarget + + depsTargetTarget @@ -508,7 +514,8 @@ let f(h, h + 1, i) = i + h - depsBuildBuildPropagated + + depsBuildBuildPropagated @@ -519,7 +526,8 @@ let f(h, h + 1, i) = i + h - propagatedNativeBuildInputs + + propagatedNativeBuildInputs @@ -539,7 +547,8 @@ let f(h, h + 1, i) = i + h - depsBuildTargetPropagated + + depsBuildTargetPropagated @@ -549,7 +558,8 @@ let f(h, h + 1, i) = i + h - depsHostHostPropagated + + depsHostHostPropagated @@ -558,7 +568,8 @@ let f(h, h + 1, i) = i + h - propagatedBuildInputs + + propagatedBuildInputs @@ -569,7 +580,8 @@ let f(h, h + 1, i) = i + h - depsTargetTarget + + depsTargetTarget @@ -586,7 +598,8 @@ let f(h, h + 1, i) = i + h Variables affecting <literal>stdenv</literal> initialisation - NIX_DEBUG + + NIX_DEBUG @@ -607,7 +620,8 @@ let f(h, h + 1, i) = i + h Variables affecting build properties - enableParallelBuilding + + enableParallelBuilding @@ -624,7 +638,8 @@ let f(h, h + 1, i) = i + h - preferLocalBuild + + preferLocalBuild @@ -642,7 +657,8 @@ let f(h, h + 1, i) = i + h Special variables - passthru + + passthru @@ -707,7 +723,8 @@ passthru = { Variables affecting phase control - phases + + phases @@ -727,7 +744,8 @@ passthru = { - prePhases + + prePhases @@ -736,7 +754,8 @@ passthru = { - preConfigurePhases + + preConfigurePhases @@ -745,7 +764,8 @@ passthru = { - preBuildPhases + + preBuildPhases @@ -754,7 +774,8 @@ passthru = { - preInstallPhases + + preInstallPhases @@ -763,7 +784,8 @@ passthru = { - preFixupPhases + + preFixupPhases @@ -772,7 +794,8 @@ passthru = { - preDistPhases + + preDistPhases @@ -781,7 +804,8 @@ passthru = { - postPhases + + postPhases @@ -804,7 +828,9 @@ passthru = { default: - Tar files + + Tar files + These can optionally be compressed using gzip @@ -817,7 +843,9 @@ passthru = { - Zip files + + Zip files + Zip files are unpacked using unzip. However, @@ -827,7 +855,9 @@ passthru = { - Directories in the Nix store + + Directories in the Nix store + These are simply copied to the current directory. The hash part of the @@ -847,7 +877,8 @@ passthru = { Variables controlling the unpack phase - srcs / src + + srcs / src @@ -857,7 +888,8 @@ passthru = { - sourceRoot + + sourceRoot @@ -869,7 +901,8 @@ passthru = { - setSourceRoot + + setSourceRoot @@ -881,7 +914,8 @@ passthru = { - preUnpack + + preUnpack @@ -890,7 +924,8 @@ passthru = { - postUnpack + + postUnpack @@ -899,7 +934,8 @@ passthru = { - dontMakeSourcesWritable + + dontMakeSourcesWritable @@ -911,7 +947,8 @@ passthru = { - unpackCmd + + unpackCmd @@ -935,7 +972,8 @@ passthru = { Variables controlling the patch phase - patches + + patches @@ -948,7 +986,8 @@ passthru = { - patchFlags + + patchFlags @@ -959,7 +998,8 @@ passthru = { - prePatch + + prePatch @@ -968,7 +1008,8 @@ passthru = { - postPatch + + postPatch @@ -991,7 +1032,8 @@ passthru = { Variables controlling the configure phase - configureScript + + configureScript @@ -1003,7 +1045,8 @@ passthru = { - configureFlags + + configureFlags @@ -1013,7 +1056,8 @@ passthru = { - configureFlagsArray + + configureFlagsArray @@ -1024,7 +1068,8 @@ passthru = { - dontAddPrefix + + dontAddPrefix @@ -1034,7 +1079,8 @@ passthru = { - prefix + + prefix @@ -1045,7 +1091,8 @@ passthru = { - dontAddDisableDepTrack + + dontAddDisableDepTrack @@ -1056,7 +1103,8 @@ passthru = { - dontFixLibtool + + dontFixLibtool @@ -1076,7 +1124,8 @@ passthru = { - dontDisableStatic + + dontDisableStatic @@ -1090,7 +1139,8 @@ passthru = { - configurePlatforms + + configurePlatforms @@ -1111,7 +1161,8 @@ passthru = { - preConfigure + + preConfigure @@ -1120,7 +1171,8 @@ passthru = { - postConfigure + + postConfigure @@ -1146,7 +1198,8 @@ passthru = { Variables controlling the build phase - dontBuild + + dontBuild @@ -1155,7 +1208,8 @@ passthru = { - makefile + + makefile @@ -1164,15 +1218,19 @@ passthru = { - checkInputs - - - A list of dependencies used by the phase. This gets included in - buildInputs when doCheck is set. - + + checkInputs + + + + A list of dependencies used by the phase. This gets included in + buildInputs when doCheck is set. + + - makeFlags + + makeFlags @@ -1193,7 +1251,8 @@ makeFlags = [ "PREFIX=$(out)" ]; - makeFlagsArray + + makeFlagsArray @@ -1211,7 +1270,8 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") - buildFlags / buildFlagsArray + + buildFlags / buildFlagsArray @@ -1222,7 +1282,8 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") - preBuild + + preBuild @@ -1231,7 +1292,8 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") - postBuild + + postBuild @@ -1266,7 +1328,8 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") Variables controlling the check phase - doCheck + + doCheck @@ -1282,9 +1345,8 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") - makeFlags / - makeFlagsArray / - makefile + + makeFlags / makeFlagsArray / makefile @@ -1293,7 +1355,8 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") - checkTarget + + checkTarget @@ -1303,7 +1366,8 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") - checkFlags / checkFlagsArray + + checkFlags / checkFlagsArray @@ -1314,7 +1378,8 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") - preCheck + + preCheck @@ -1323,7 +1388,8 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") - postCheck + + postCheck @@ -1347,9 +1413,8 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") Variables controlling the install phase - makeFlags / - makeFlagsArray / - makefile + + makeFlags / makeFlagsArray / makefile @@ -1358,7 +1423,8 @@ makeFlagsArray=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") - installTargets + + installTargets @@ -1370,7 +1436,8 @@ installTargets = "install-bin install-doc"; - installFlags / installFlagsArray + + installFlags / installFlagsArray @@ -1381,7 +1448,8 @@ installTargets = "install-bin install-doc"; - preInstall + + preInstall @@ -1390,7 +1458,8 @@ installTargets = "install-bin install-doc"; - postInstall + + postInstall @@ -1444,7 +1513,8 @@ installTargets = "install-bin install-doc"; Variables controlling the fixup phase - dontStrip + + dontStrip @@ -1454,7 +1524,8 @@ installTargets = "install-bin install-doc"; - dontStripHost + + dontStripHost @@ -1466,7 +1537,8 @@ installTargets = "install-bin install-doc"; - dontStripTarget + + dontStripTarget @@ -1478,7 +1550,8 @@ installTargets = "install-bin install-doc"; - dontMoveSbin + + dontMoveSbin @@ -1488,7 +1561,8 @@ installTargets = "install-bin install-doc"; - stripAllList + + stripAllList @@ -1500,7 +1574,8 @@ installTargets = "install-bin install-doc"; - stripAllFlags + + stripAllFlags @@ -1511,7 +1586,8 @@ installTargets = "install-bin install-doc"; - stripDebugList + + stripDebugList @@ -1522,7 +1598,8 @@ installTargets = "install-bin install-doc"; - stripDebugFlags + + stripDebugFlags @@ -1533,7 +1610,8 @@ installTargets = "install-bin install-doc"; - dontPatchELF + + dontPatchELF @@ -1543,7 +1621,8 @@ installTargets = "install-bin install-doc"; - dontPatchShebangs + + dontPatchShebangs @@ -1553,7 +1632,8 @@ installTargets = "install-bin install-doc"; - forceShare + + forceShare @@ -1564,7 +1644,8 @@ installTargets = "install-bin install-doc"; - setupHook + + setupHook @@ -1579,7 +1660,8 @@ installTargets = "install-bin install-doc"; - preFixup + + preFixup @@ -1588,7 +1670,8 @@ installTargets = "install-bin install-doc"; - postFixup + + postFixup @@ -1597,7 +1680,8 @@ installTargets = "install-bin install-doc"; - separateDebugInfo + + separateDebugInfo @@ -1639,7 +1723,8 @@ set debug-file-directory ~/.nix-profile/lib/debug Variables controlling the installCheck phase - doInstallCheck + + doInstallCheck @@ -1655,16 +1740,20 @@ set debug-file-directory ~/.nix-profile/lib/debug - installCheckInputs - - - A list of dependencies used by the phase. This gets included in - buildInputs when doInstallCheck - is set. - + + installCheckInputs + + + + A list of dependencies used by the phase. This gets included in + buildInputs when doInstallCheck is + set. + + - preInstallCheck + + preInstallCheck @@ -1673,7 +1762,8 @@ set debug-file-directory ~/.nix-profile/lib/debug - postInstallCheck + + postInstallCheck @@ -1698,7 +1788,8 @@ set debug-file-directory ~/.nix-profile/lib/debug Variables controlling the distribution phase - distTarget + + distTarget @@ -1708,7 +1799,8 @@ set debug-file-directory ~/.nix-profile/lib/debug - distFlags / distFlagsArray + + distFlags / distFlagsArray @@ -1717,7 +1809,8 @@ set debug-file-directory ~/.nix-profile/lib/debug - tarballs + + tarballs @@ -1728,7 +1821,8 @@ set debug-file-directory ~/.nix-profile/lib/debug - dontCopyDist + + dontCopyDist @@ -1737,7 +1831,8 @@ set debug-file-directory ~/.nix-profile/lib/debug - preDist + + preDist @@ -1746,7 +1841,8 @@ set debug-file-directory ~/.nix-profile/lib/debug - postDist + + postDist @@ -1766,7 +1862,8 @@ set debug-file-directory ~/.nix-profile/lib/debug - makeWrapperexecutablewrapperfileargs + + makeWrapper executable wrapperfile args @@ -1791,7 +1888,8 @@ makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello - substituteinfileoutfilesubs + + substitute infile outfile subs @@ -1801,7 +1899,8 @@ makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello subs are of the following form: - s1s2 + + s1 s2 @@ -1811,7 +1910,8 @@ makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello - varName + + varName @@ -1826,7 +1926,8 @@ makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello - varNames + + varName s @@ -1860,7 +1961,8 @@ substitute ./foo.in ./foo.out \ - substituteInPlacefilesubs + + substituteInPlace file subs @@ -1870,7 +1972,8 @@ substitute ./foo.in ./foo.out \ - substituteAllinfileoutfile + + substituteAll infile outfile @@ -1909,7 +2012,8 @@ echo @foo@ - substituteAllInPlacefile + + substituteAllInPlace file @@ -1919,7 +2023,8 @@ echo @foo@ - stripHashpath + + stripHash path @@ -1939,7 +2044,8 @@ someVar=$(stripHash $name) - wrapProgramexecutablemakeWrapperArgs + + wrapProgram executable makeWrapperArgs @@ -2039,7 +2145,9 @@ addEnvHooks "$hostOffset" myBashFunction mechanism is only to be used as a last resort, it might be. - Bintools Wrapper + + Bintools Wrapper + Bintools Wrapper wraps the binary utilities for a bunch of miscellaneous @@ -2109,7 +2217,9 @@ addEnvHooks "$hostOffset" myBashFunction - CC Wrapper + + CC Wrapper + CC Wrapper wraps a C toolchain for a bunch of miscellaneous purposes. @@ -2140,7 +2250,9 @@ addEnvHooks "$hostOffset" myBashFunction - Perl + + Perl + Adds the lib/site_perl subdirectory of each build @@ -2152,7 +2264,9 @@ addEnvHooks "$hostOffset" myBashFunction - Python + + Python + Adds the lib/${python.libPrefix}/site-packages @@ -2162,7 +2276,9 @@ addEnvHooks "$hostOffset" myBashFunction - pkg-config + + pkg-config + Adds the lib/pkgconfig and @@ -2172,7 +2288,9 @@ addEnvHooks "$hostOffset" myBashFunction - Automake + + Automake + Adds the share/aclocal subdirectory of each build @@ -2181,7 +2299,9 @@ addEnvHooks "$hostOffset" myBashFunction - Autoconf + + Autoconf + The autoreconfHook derivation adds @@ -2192,7 +2312,9 @@ addEnvHooks "$hostOffset" myBashFunction - libxml2 + + libxml2 + Adds every file named catalog.xml found under the @@ -2203,7 +2325,9 @@ addEnvHooks "$hostOffset" myBashFunction - teTeX / TeX Live + + teTeX / TeX Live + Adds the share/texmf-nix subdirectory of each build @@ -2212,7 +2336,9 @@ addEnvHooks "$hostOffset" myBashFunction - Qt 4 + + Qt 4 + Sets the QTDIR environment variable to Qt’s path. @@ -2220,7 +2346,9 @@ addEnvHooks "$hostOffset" myBashFunction - gdk-pixbuf + + gdk-pixbuf + Exports GDK_PIXBUF_MODULE_FILE environment variable the @@ -2230,7 +2358,9 @@ addEnvHooks "$hostOffset" myBashFunction - GHC + + GHC + Creates a temporary package database and registers every Haskell build @@ -2239,7 +2369,9 @@ addEnvHooks "$hostOffset" myBashFunction - GStreamer + + GStreamer + Adds the GStreamer plugins subdirectory of each build input to the @@ -2249,7 +2381,9 @@ addEnvHooks "$hostOffset" myBashFunction - paxctl + + paxctl + Defines the paxmark helper for setting per-executable @@ -2271,7 +2405,9 @@ addEnvHooks "$hostOffset" myBashFunction - autoPatchelfHook + + autoPatchelfHook + This is a special setup hook which helps in packaging proprietary @@ -2330,7 +2466,8 @@ addEnvHooks "$hostOffset" myBashFunction - format + + format @@ -2354,7 +2491,8 @@ cc1plus: some warnings being treated as errors - stackprotector + + stackprotector @@ -2375,7 +2513,8 @@ bin/blib.a(bios_console.o): In function `bios_handle_cup': - fortify + + fortify @@ -2415,7 +2554,8 @@ fcntl2.h:50:4: error: call to '__open_missing_mode' declared with attribute erro - pic + + pic @@ -2439,7 +2579,8 @@ ccbLfRgg.s:33: Error: missing or invalid displacement expression `private_key_le - strictoverflow + + strictoverflow @@ -2457,7 +2598,8 @@ ccbLfRgg.s:33: Error: missing or invalid displacement expression `private_key_le - relro + + relro @@ -2477,7 +2619,8 @@ ccbLfRgg.s:33: Error: missing or invalid displacement expression `private_key_le - bindnow + + bindnow @@ -2509,7 +2652,8 @@ intel_drv.so: undefined symbol: vgaHWFreeHWRec - pie + + pie diff --git a/nixos/doc/manual/Makefile b/nixos/doc/manual/Makefile index 2e2322d5fb51..5cbbf140869a 100644 --- a/nixos/doc/manual/Makefile +++ b/nixos/doc/manual/Makefile @@ -14,6 +14,11 @@ format: find . -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \ xmlformat --config-file "../xmlformat.conf" -i {} +.PHONY: fix-misc-xml +fix-misc-xml: + find . -iname '*.xml' -type f \ + -exec ../varlistentry-fixer.rb {} ';' + .PHONY: clean clean: rm -f manual-combined.xml generated diff --git a/nixos/doc/manual/administration/boot-problems.xml b/nixos/doc/manual/administration/boot-problems.xml index 5f05ad261ef3..de3d8ac21aeb 100644 --- a/nixos/doc/manual/administration/boot-problems.xml +++ b/nixos/doc/manual/administration/boot-problems.xml @@ -14,7 +14,8 @@ NixOS boot scripts or by systemd: - boot.shell_on_fail + + boot.shell_on_fail @@ -25,7 +26,8 @@ - boot.debug1 + + boot.debug1 @@ -37,7 +39,8 @@ - boot.trace + + boot.trace @@ -46,7 +49,8 @@ - single + + single @@ -59,7 +63,8 @@ - systemd.log_level=debug systemd.log_target=console + + systemd.log_level=debug systemd.log_target=console diff --git a/nixos/doc/manual/configuration/config-file.xml b/nixos/doc/manual/configuration/config-file.xml index a9420b3fc921..8a1a39c98c10 100644 --- a/nixos/doc/manual/configuration/config-file.xml +++ b/nixos/doc/manual/configuration/config-file.xml @@ -80,7 +80,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no Options have various types of values. The most important are: - Strings + + Strings + Strings are enclosed in double quotes, e.g. @@ -112,7 +114,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no - Booleans + + Booleans + These can be true or false, e.g. @@ -124,7 +128,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no - Integers + + Integers + For example, @@ -141,7 +147,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no - Sets + + Sets + Sets were introduced above. They are name/value pairs enclosed in braces, @@ -157,7 +165,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no - Lists + + Lists + The important thing to note about lists is that list elements are @@ -173,7 +183,9 @@ swapDevices = [ { device = "/dev/disk/by-label/swap"; } ]; - Packages + + Packages + Usually, the packages you need are already part of the Nix Packages diff --git a/nixos/doc/manual/development/building-parts.xml b/nixos/doc/manual/development/building-parts.xml index 031048aaa377..eaffc0ef47c2 100644 --- a/nixos/doc/manual/development/building-parts.xml +++ b/nixos/doc/manual/development/building-parts.xml @@ -15,7 +15,8 @@ $ nix-build -A config.option include: - system.build.toplevel + + system.build.toplevel @@ -32,7 +33,8 @@ $ nix-build -A system - system.build.manual.manual + + system.build.manual.manual @@ -41,7 +43,8 @@ $ nix-build -A system - system.build.etc + + system.build.etc @@ -51,9 +54,11 @@ $ nix-build -A system - system.build.initialRamdisk + + system.build.initialRamdisk - system.build.kernel + + system.build.kernel @@ -69,11 +74,14 @@ $ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/ - system.build.nixos-rebuild + + system.build.nixos-rebuild - system.build.nixos-install + + system.build.nixos-install - system.build.nixos-generate-config + + system.build.nixos-generate-config @@ -82,7 +90,8 @@ $ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/ - systemd.units.unit-name.unit + + systemd.units.unit-name.unit diff --git a/nixos/doc/manual/development/option-declarations.xml b/nixos/doc/manual/development/option-declarations.xml index a8f528a0a804..eee81bf64263 100644 --- a/nixos/doc/manual/development/option-declarations.xml +++ b/nixos/doc/manual/development/option-declarations.xml @@ -32,7 +32,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> The function mkOption accepts the following arguments. - type + + type @@ -43,7 +44,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> - default + + default @@ -55,7 +57,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> - example + + example @@ -64,7 +67,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> - description + + description diff --git a/nixos/doc/manual/development/option-types.xml b/nixos/doc/manual/development/option-types.xml index 5cb747e6d9f1..47dd09158e91 100644 --- a/nixos/doc/manual/development/option-types.xml +++ b/nixos/doc/manual/development/option-types.xml @@ -22,7 +22,8 @@ - types.attrs + + types.attrs @@ -31,7 +32,8 @@ - types.bool + + types.bool @@ -41,7 +43,8 @@ - types.path + + types.path @@ -52,7 +55,8 @@ - types.package + + types.package @@ -68,7 +72,8 @@ - types.int + + types.int @@ -77,7 +82,8 @@ - types.ints.{s8, s16, s32} + + types.ints.{s8, s16, s32} @@ -91,7 +97,8 @@ - types.ints.unsigned + + types.ints.unsigned @@ -100,7 +107,8 @@ - types.ints.{u8, u16, u32} + + types.ints.{u8, u16, u32} @@ -114,7 +122,8 @@ - types.ints.positive + + types.ints.positive @@ -130,7 +139,8 @@ - types.str + + types.str @@ -139,7 +149,8 @@ - types.lines + + types.lines @@ -149,7 +160,8 @@ - types.commas + + types.commas @@ -159,7 +171,8 @@ - types.envVar + + types.envVar @@ -169,7 +182,8 @@ - types.strMatching + + types.strMatching @@ -191,7 +205,8 @@ - types.enuml + + types.enum l @@ -202,7 +217,8 @@ - types.separatedStringsep + + types.separatedString sep @@ -212,7 +228,8 @@ - types.ints.betweenlowesthighest + + types.ints.between lowest highest @@ -223,7 +240,8 @@ - types.submoduleo + + types.submodule o @@ -250,7 +268,8 @@ - types.listOft + + types.listOf t @@ -260,7 +279,8 @@ - types.attrsOft + + types.attrsOf t @@ -271,7 +291,8 @@ - types.loaOft + + types.loaOf t @@ -281,7 +302,8 @@ - types.nullOrt + + types.nullOr t @@ -291,7 +313,8 @@ - types.uniqt + + types.uniq t @@ -301,7 +324,8 @@ - types.eithert1t2 + + types.either t1 t2 @@ -312,7 +336,8 @@ - types.coercedTofromfto + + types.coercedTo from f to @@ -468,7 +493,8 @@ config.mod.two = { foo = 2; bar = "two"; }; - check + + check @@ -501,7 +527,8 @@ nixThings = mkOption { - merge + + merge @@ -534,7 +561,8 @@ nixThings = mkOption { - name + + name @@ -543,7 +571,8 @@ nixThings = mkOption { - definition + + definition @@ -553,7 +582,8 @@ nixThings = mkOption { - check + + check @@ -565,7 +595,8 @@ nixThings = mkOption { - merge + + merge @@ -573,7 +604,8 @@ nixThings = mkOption { - loc + + loc @@ -583,7 +615,8 @@ nixThings = mkOption { - defs + + defs @@ -600,7 +633,8 @@ nixThings = mkOption { - getSubOptions + + getSubOptions @@ -615,7 +649,8 @@ nixThings = mkOption { - getSubModules + + getSubModules @@ -628,7 +663,8 @@ nixThings = mkOption { - substSubModules + + substSubModules @@ -644,7 +680,8 @@ nixThings = mkOption { - typeMerge + + typeMerge @@ -654,7 +691,8 @@ nixThings = mkOption { - f + + f @@ -670,7 +708,8 @@ nixThings = mkOption { - functor + + functor @@ -679,7 +718,8 @@ nixThings = mkOption { - type + + type @@ -688,7 +728,8 @@ nixThings = mkOption { - wrapped + + wrapped @@ -697,7 +738,8 @@ nixThings = mkOption { - payload + + payload @@ -709,7 +751,8 @@ nixThings = mkOption { - binOp + + binOp diff --git a/nixos/doc/manual/development/writing-nixos-tests.xml b/nixos/doc/manual/development/writing-nixos-tests.xml index 89a6a4423627..5935fbc049bd 100644 --- a/nixos/doc/manual/development/writing-nixos-tests.xml +++ b/nixos/doc/manual/development/writing-nixos-tests.xml @@ -54,7 +54,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf - + + @@ -63,7 +64,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf - + + @@ -75,7 +77,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf - + + @@ -120,7 +123,8 @@ startAll; The following methods are available on machine objects: - start + + start @@ -130,7 +134,8 @@ startAll; - shutdown + + shutdown @@ -139,7 +144,8 @@ startAll; - crash + + crash @@ -148,7 +154,8 @@ startAll; - block + + block @@ -158,7 +165,8 @@ startAll; - unblock + + unblock @@ -167,7 +175,8 @@ startAll; - screenshot + + screenshot @@ -177,7 +186,8 @@ startAll; - getScreenText + + getScreenText @@ -193,7 +203,8 @@ startAll; - sendMonitorCommand + + sendMonitorCommand @@ -203,7 +214,8 @@ startAll; - sendKeys + + sendKeys @@ -213,7 +225,8 @@ startAll; - sendChars + + sendChars @@ -224,7 +237,8 @@ startAll; - execute + + execute @@ -235,7 +249,8 @@ startAll; - succeed + + succeed @@ -245,7 +260,8 @@ startAll; - fail + + fail @@ -255,7 +271,8 @@ startAll; - waitUntilSucceeds + + waitUntilSucceeds @@ -264,7 +281,8 @@ startAll; - waitUntilFails + + waitUntilFails @@ -273,7 +291,8 @@ startAll; - waitForUnit + + waitForUnit @@ -282,7 +301,8 @@ startAll; - waitForFile + + waitForFile @@ -291,7 +311,8 @@ startAll; - waitForOpenPort + + waitForOpenPort @@ -301,7 +322,8 @@ startAll; - waitForClosedPort + + waitForClosedPort @@ -310,7 +332,8 @@ startAll; - waitForX + + waitForX @@ -319,7 +342,8 @@ startAll; - waitForText + + waitForText @@ -336,7 +360,8 @@ startAll; - waitForWindow + + waitForWindow @@ -346,7 +371,8 @@ startAll; - copyFileFromHost + + copyFileFromHost @@ -361,7 +387,8 @@ startAll; - systemctl + + systemctl diff --git a/nixos/doc/manual/installation/installing.xml b/nixos/doc/manual/installation/installing.xml index 4e1fde662d6e..6066d025adbf 100644 --- a/nixos/doc/manual/installation/installing.xml +++ b/nixos/doc/manual/installation/installing.xml @@ -16,7 +16,9 @@ - UEFI systems + + UEFI systems + You should boot the live CD in UEFI mode (consult your specific @@ -138,7 +140,9 @@ - UEFI systems + + UEFI systems + For creating boot partitions: mkfs.fat. Again @@ -178,7 +182,9 @@ - UEFI systems + + UEFI systems + Mount the boot file system on /mnt/boot, e.g. @@ -234,7 +240,9 @@ - BIOS systems + + BIOS systems + You must set the option @@ -244,7 +252,9 @@ - UEFI systems + + UEFI systems + You must set the option diff --git a/nixos/doc/manual/man-nixos-build-vms.xml b/nixos/doc/manual/man-nixos-build-vms.xml index 02dad4c548b8..87e4f3dae869 100644 --- a/nixos/doc/manual/man-nixos-build-vms.xml +++ b/nixos/doc/manual/man-nixos-build-vms.xml @@ -12,14 +12,22 @@ build a network of virtual machines from a network of NixOS configurations - nixos-build-vms - + + nixos-build-vms + + - + + + - + + + - network.nix + + + network.nix @@ -78,7 +86,8 @@ - + + @@ -87,7 +96,8 @@ - + + @@ -96,7 +106,8 @@ - , + + , diff --git a/nixos/doc/manual/man-nixos-enter.xml b/nixos/doc/manual/man-nixos-enter.xml index 7db4b72ee36e..42edaa1ae5b6 100644 --- a/nixos/doc/manual/man-nixos-enter.xml +++ b/nixos/doc/manual/man-nixos-enter.xml @@ -12,26 +12,40 @@ run a command in a NixOS chroot environment - nixos-enter + + nixos-enter - - root + + + + root + - - system + + + + system + - - shell-command + + + + shell-command + - + + + - - arguments + + + + arguments @@ -50,7 +64,8 @@ - + + @@ -60,7 +75,8 @@ - + + @@ -72,9 +88,11 @@ - + + - + + @@ -83,7 +101,8 @@ - + + diff --git a/nixos/doc/manual/man-nixos-generate-config.xml b/nixos/doc/manual/man-nixos-generate-config.xml index 8bf90f452db6..1227873f5780 100644 --- a/nixos/doc/manual/man-nixos-generate-config.xml +++ b/nixos/doc/manual/man-nixos-generate-config.xml @@ -12,16 +12,24 @@ generate NixOS configuration modules - nixos-generate-config - - + + nixos-generate-config - - root + + - - dir + + + + root + + + + + + + dir @@ -31,7 +39,8 @@ This command writes two NixOS configuration modules: - + + @@ -53,7 +62,8 @@ - + + @@ -74,7 +84,8 @@ - + + @@ -88,7 +99,8 @@ - + + @@ -99,7 +111,8 @@ - + + @@ -109,7 +122,8 @@ - + + @@ -119,7 +133,8 @@ - + + diff --git a/nixos/doc/manual/man-nixos-install.xml b/nixos/doc/manual/man-nixos-install.xml index 2d45e83a863f..25f4f40613ac 100644 --- a/nixos/doc/manual/man-nixos-install.xml +++ b/nixos/doc/manual/man-nixos-install.xml @@ -12,47 +12,76 @@ install bootloader and NixOS - nixos-install + + nixos-install - - path + + + + path + - - root + + + + root + - - path + + + + path + - + + + - + + + - + + - - - - - number - - number - - namevalue - + - + + + + + + + + + number + + + + number + + + + name value + + + + + + - + + @@ -106,7 +135,8 @@ - + + @@ -117,7 +147,8 @@ - + + @@ -135,7 +166,8 @@ - + + @@ -147,9 +179,11 @@ - + + - + + @@ -160,7 +194,8 @@ - + + @@ -177,7 +212,8 @@ - namevalue + + name value @@ -187,7 +223,8 @@ - + + @@ -197,7 +234,8 @@ - + + diff --git a/nixos/doc/manual/man-nixos-option.xml b/nixos/doc/manual/man-nixos-option.xml index c22c3811dedf..d436cce742a2 100644 --- a/nixos/doc/manual/man-nixos-option.xml +++ b/nixos/doc/manual/man-nixos-option.xml @@ -12,14 +12,22 @@ inspect a NixOS configuration - nixos-option - path + + nixos-option + + path - + + + - + + + - option.name + + + option.name @@ -42,7 +50,8 @@ - path + + path @@ -52,7 +61,8 @@ - + + @@ -62,7 +72,8 @@ - + + @@ -76,7 +87,8 @@ Environment - NIXOS_CONFIG + + NIXOS_CONFIG diff --git a/nixos/doc/manual/man-nixos-rebuild.xml b/nixos/doc/manual/man-nixos-rebuild.xml index e1a2c7108d18..551a65f5e96b 100644 --- a/nixos/doc/manual/man-nixos-rebuild.xml +++ b/nixos/doc/manual/man-nixos-rebuild.xml @@ -12,43 +12,75 @@ reconfigure a NixOS machine - nixos-rebuild - + + nixos-rebuild + + - + + + - + + + - + + + - + + + - + + + - + + + - - + + + + + - + + - + + + - + + + - + + + - + + + - - + + + + - - name + + + + + name - + + @@ -68,7 +100,8 @@ operation. It must be one of the following: - + + @@ -82,7 +115,8 @@ - + + @@ -94,7 +128,8 @@ - + + @@ -107,7 +142,8 @@ - + + @@ -124,7 +160,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system - + + @@ -134,7 +171,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system - + + @@ -147,7 +185,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system - + + @@ -186,7 +225,8 @@ $ ./result/bin/run-*-vm - + + @@ -213,7 +253,8 @@ $ ./result/bin/run-*-vm - + + @@ -222,7 +263,8 @@ $ ./result/bin/run-*-vm - + + @@ -232,7 +274,8 @@ $ ./result/bin/run-*-vm - + + @@ -246,7 +289,8 @@ $ ./result/bin/run-*-vm - + + @@ -258,7 +302,8 @@ $ ./result/bin/run-*-vm - + + @@ -271,9 +316,11 @@ $ ./result/bin/run-*-vm - + + - + + @@ -299,7 +346,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix - + + @@ -323,7 +371,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix - + + @@ -361,7 +410,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix Environment - NIXOS_CONFIG + + NIXOS_CONFIG @@ -371,7 +421,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix - NIX_SSHOPTS + + NIX_SSHOPTS @@ -386,7 +437,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix Files - /run/current-system + + /run/current-system @@ -395,7 +447,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix - /nix/var/nix/profiles/system + + /nix/var/nix/profiles/system diff --git a/nixos/doc/manual/man-nixos-version.xml b/nixos/doc/manual/man-nixos-version.xml index c173bce19136..931c4a5ad029 100644 --- a/nixos/doc/manual/man-nixos-version.xml +++ b/nixos/doc/manual/man-nixos-version.xml @@ -11,10 +11,14 @@ show the NixOS version - nixos-version - + + nixos-version + + - + + + @@ -29,7 +33,8 @@ The version consists of the following elements: - 16.03 + + 16.03 @@ -39,7 +44,8 @@ - 1011 + + 1011 @@ -53,7 +59,8 @@ - 6317da4 + + 6317da4 @@ -63,7 +70,8 @@ - Emu + + Emu @@ -83,9 +91,11 @@ - + + - + + diff --git a/nixos/doc/manual/release-notes/rl-1509.xml b/nixos/doc/manual/release-notes/rl-1509.xml index 734bc076b852..2465f370cf13 100644 --- a/nixos/doc/manual/release-notes/rl-1509.xml +++ b/nixos/doc/manual/release-notes/rl-1509.xml @@ -435,11 +435,11 @@ system.autoUpgrade.enable = true; system.nixos.stateVersion = "14.12"; - The new option ensures that certain - configuration changes that could break existing systems (such as the - sshd host key setting) will maintain compatibility with - the specified NixOS release. NixOps sets the state version of existing - deployments automatically. + The new option ensures that + certain configuration changes that could break existing systems (such as + the sshd host key setting) will maintain compatibility + with the specified NixOS release. NixOps sets the state version of + existing deployments automatically. diff --git a/nixos/doc/manual/release-notes/rl-1809.xml b/nixos/doc/manual/release-notes/rl-1809.xml index 35dc69515ffd..ae0f35046fff 100644 --- a/nixos/doc/manual/release-notes/rl-1809.xml +++ b/nixos/doc/manual/release-notes/rl-1809.xml @@ -53,10 +53,12 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' - When enabled the iproute2 will copy the files - expected by ip route (e.g., rt_tables) in - /run/iproute2. This allows to write aliases for - routing tables for instance. + + When enabled the iproute2 will copy the files expected + by ip route (e.g., rt_tables) in + /run/iproute2. This allows to write aliases for + routing tables for instance. + @@ -99,20 +101,24 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' - The services.docker-registry.extraConfig object doesn't contain - environment variables anymore. Instead it needs to provide an object structure - that can be mapped onto the YAML configuration defined in the docker/distribution docs. + The services.docker-registry.extraConfig object doesn't + contain environment variables anymore. Instead it needs to provide an + object structure that can be mapped onto the YAML configuration defined in + the + docker/distribution docs. - gnucash has changed from version 2.4 to 3.x. - If you've been using gnucash (version 2.4) instead of - gnucash26 (version 2.6) you must open your Gnucash - data file(s) with gnucash26 and then save them to - upgrade the file format. Then you may use your data file(s) with - Gnucash 3.x. See the upgrade documentation. - Gnucash 2.4 is still available under the attribute gnucash24. + gnucash has changed from version 2.4 to 3.x. If you've + been using gnucash (version 2.4) instead of + gnucash26 (version 2.6) you must open your Gnucash data + file(s) with gnucash26 and then save them to upgrade + the file format. Then you may use your data file(s) with Gnucash 3.x. See + the upgrade + documentation. + Gnucash 2.4 is still available under the attribute + gnucash24. @@ -128,9 +134,9 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' - dockerTools.pullImage relies on image digest - instead of image tag to download the image. The - sha256 of a pulled image has to be updated. + dockerTools.pullImage relies on image digest instead of + image tag to download the image. The sha256 of a pulled + image has to be updated. @@ -187,32 +193,40 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' The module for has two new options now: - - - - Puts the generated Diffie-Hellman parameters into the Nix store instead - of managing them in a stateful manner in - /var/lib/dhparams. - + + + + + + Puts the generated Diffie-Hellman parameters into the Nix store instead + of managing them in a stateful manner in + /var/lib/dhparams. + + - - - The default bit size to use for the generated Diffie-Hellman parameters. - + + + + + + The default bit size to use for the generated Diffie-Hellman + parameters. + + - - - The path to the actual generated parameter files should now be queried - using - config.security.dhparams.params.name.path - because it might be either in the Nix store or in a directory configured - by . - - + + + The path to the actual generated parameter files should now be queried + using + config.security.dhparams.params.name.path + because it might be either in the Nix store or in a directory configured + by . + + For developers: @@ -237,20 +251,23 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' - networking.networkmanager.useDnsmasq has been deprecated. Use - networking.networkmanager.dns instead. + networking.networkmanager.useDnsmasq has been + deprecated. Use networking.networkmanager.dns instead. - The option services.kubernetes.apiserver.admissionControl - was renamed to services.kubernetes.apiserver.enableAdmissionPlugins. + The option + services.kubernetes.apiserver.admissionControl was + renamed to + services.kubernetes.apiserver.enableAdmissionPlugins. Recommented way to access the Kubernetes Dashboard is with HTTPS (TLS) - Therefore; public service port for the dashboard has changed to 443 (container port 8443) and scheme to https. + Therefore; public service port for the dashboard has changed to 443 + (container port 8443) and scheme to https. diff --git a/nixos/doc/manual/shell.nix b/nixos/doc/manual/shell.nix index 7f8422b4ec11..cc3609d750e0 100644 --- a/nixos/doc/manual/shell.nix +++ b/nixos/doc/manual/shell.nix @@ -4,5 +4,5 @@ in pkgs.mkShell { name = "nixos-manual"; - buildInputs = with pkgs; [ xmlformat jing xmloscopy ]; + buildInputs = with pkgs; [ xmlformat jing xmloscopy ruby ]; } diff --git a/nixos/doc/varlistentry-fixer.rb b/nixos/doc/varlistentry-fixer.rb new file mode 100755 index 000000000000..6c7cc1e6439b --- /dev/null +++ b/nixos/doc/varlistentry-fixer.rb @@ -0,0 +1,124 @@ +#!/usr/bin/env ruby + +# This script is written intended as a living, evolving tooling +# to fix oopsies within the docbook documentation. +# +# This is *not* a formatter. It, instead, handles some known cases +# where something bad happened, and fixing it manually is tedious. +# +# Read the code to see the different cases it handles. +# +# ALWAYS `make format` after fixing with this! +# ALWAYS read the changes, this tool isn't yet proven to be always right. + +require "rexml/document" +include REXML + +if ARGV.length < 1 then + $stderr.puts "Needs a filename." + exit 1 +end + +filename = ARGV.shift +doc = Document.new(File.open(filename)) + +$touched = false + +# Fixing varnames having a sibling element without spacing. +# This is to fix an initial `xmlformat` issue where `term` +# would mangle as spaces. +# +# +# types.separatedStringsep <---- +# +# ... +# +# Generates: types.separatedStringsep +# ^^^^ +# +# +# +# makeWrapperexecutablewrapperfileargs <---- +# +# +# Generates: makeWrapperexecutablewrapperfileargs +# ^^^^ ^^^^ ^^ ^^ +# +# +# namevalue <----- +# +# +# Generates: --optionnamevalue +# ^^ ^^ +doc.elements.each("//varlistentry/term") do |term| + ["varname", "function", "option", "replaceable"].each do |prev_name| + term.elements.each(prev_name) do |el| + if el.next_element and + el.next_element.name == "replaceable" and + el.next_sibling_node.class == Element + then + $touched = true + term.insert_after(el, Text.new(" ")) + end + end + end +end + + + +# +# nixos-option +# +# path <------ +# +# +# Generates: -Ipath +# ^^ +doc.elements.each("//cmdsynopsis/arg") do |term| + ["option", "replaceable"].each do |prev_name| + term.elements.each(prev_name) do |el| + if el.next_element and + el.next_element.name == "replaceable" and + el.next_sibling_node.class == Element + then + $touched = true + term.insert_after(el, Text.new(" ")) + end + end + end +end + +# +# +# +# +# +# +# +# +# +# +# name <---- +# +# +# Generates: [{--profile-name | -p }name] +# ^^^^ +doc.elements.each("//cmdsynopsis/arg") do |term| + ["group"].each do |prev_name| + term.elements.each(prev_name) do |el| + if el.next_element and + el.next_element.name == "replaceable" and + el.next_sibling_node.class == Element + then + $touched = true + term.insert_after(el, Text.new(" ")) + end + end + end +end + + +if $touched then + doc.context[:attribute_quote] = :quote + doc.write(output: File.open(filename, "w")) +end diff --git a/nixos/doc/xmlformat.conf b/nixos/doc/xmlformat.conf index 50255857b24a..4a565c8465bc 100644 --- a/nixos/doc/xmlformat.conf +++ b/nixos/doc/xmlformat.conf @@ -67,6 +67,7 @@ programlisting screen entry-break = 0 exit-break = 0 - -#term -# format inline +# This is needed so that the spacing inside those tags is kept. +term cmdsynopsis arg + normalize yes + format block