commit 924a07dc227b69b53e3f43d2d08996d33b364c92 · pyrox.dev/nixpkgs

+82 -9

nixos/doc/manual/contributing-to-this-manual.chapter.md

···

       6
       6
        
       

     

       7
       7
        
       ```ShellSession

     

       8
       8
        
       $ cd /path/to/nixpkgs

     

       9
       9
       +
       $ $EDITOR doc/nixos/manual/... # edit the manual

     

       9
       10
        
       $ nix-build nixos/release.nix -A manual.x86_64-linux

     

       10
       11
        
       ```

     

       11
       12
        
       

     
···

       13
       14
        
       

     

       14
       15
        
       There's also [a convenient development daemon](https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-devmode).

     

       15
       16
        
       

     

       16
       16
       -
       **Contributing to the man pages**

     

       17
       17
       +
       The above instructions don't deal with the appendix of available `configuration.nix` options, and the manual pages related to NixOS. These are built, and written in a different location and in a different format, as explained in the next sections.

     

       18
       18
       +
       

     

       19
       19
       +
       ## Contributing to the `configuration.nix` options documentation {#sec-contributing-options}

     

       20
       20
       +
       

     

       21
       21
       +
       The documentation for all the different `configuration.nix` options is automatically generated by reading the `description`s of all the NixOS options defined at `nixos/modules/`. If you want to improve such `description`, find it in the `nixos/modules/` directory, and edit it and open a pull request.

     

       22
       22
       +
       

     

       23
       23
       +
       To see how your changes render on the web, run again:

     

       24
       24
       +
       

     

       25
       25
       +
       ```ShellSession

     

       26
       26
       +
       $ nix-build nixos/release.nix -A manual.x86_64-linux

     

       27
       27
       +
       ```

     

       17
       28
        
       

     

       18
       18
       -
       The man pages are written in [DocBook] which is XML.

     

       29
       29
       +
       And you'll see the changes to the appendix in the path `result/share/doc/nixos/options.html`.

     

       19
       30
        
       

     

       20
       20
       -
       To see what your edits look like:

     

       31
       31
       +
       You can also build only the `configuration.nix(5)` manual page, via:

     

       21
       32
        
       

     

       22
       33
        
       ```ShellSession

     

       23
       34
        
       $ cd /path/to/nixpkgs

     

       24
       24
       -
       $ nix-build nixos/release.nix -A manpages.x86_64-linux

     

       35
       35
       +
       $ nix-build nixos/release.nix -A nixos-configuration-reference-manpage.x86_64-linux

     

       25
       36
        
       ```

     

       26
       37
        
       

     

       27
       27
       -
       You can then read the man page you edited by running

     

       38
       38
       +
       And observe the result via:

     

       28
       39
        
       

     

       29
       40
        
       ```ShellSession

     

       30
       30
       -
       $ man --manpath=result/share/man nixos-rebuild # Replace nixos-rebuild with the command whose manual you edited

     

       41
       41
       +
       $ man --local-file result/share/man/man5/configuration.nix.5

     

       42
       42
       +
       ```

     

       43
       43
       +
       

     

       44
       44
       +
       If you're on a different architecture that's supported by NixOS (check file `nixos/release.nix` on Nixpkgs' repository) then replace `x86_64-linux` with the architecture. `nix-build` will complain otherwise, but should also tell you which architecture you have + the supported ones.

     

       45
       45
       +
       

     

       46
       46
       +
       ## Contributing to `nixos-*` tools' manpages {#sec-contributing-nixos-tools}

     

       47
       47
       +
       

     

       48
       48
       +
       The manual pages for the tools available in the installation image can be found in Nixpkgs' by running (e.g for `nixos-rebuild`):

     

       49
       49
       +
       

     

       50
       50
       +
       ```ShellSession

     

       51
       51
       +
       $ git ls | grep nixos-rebuild.8

     

       52
       52
       +
       ```

     

       53
       53
       +
       

     

       54
       54
       +
       Man pages are written in [`mdoc(7)` format](https://mandoc.bsd.lv/man/mdoc.7.html) and should be portable between mandoc and groff for rendering (though minor differences may occur, mandoc and groff seem to have slightly different spacing rules.)

     

       55
       55
       +
       

     

       56
       56
       +
       For previewing edited files, you can just run `man --local-file path/to/file.8` and you will see it rendered.

     

       57
       57
       +
       

     

       58
       58
       +
       Being written in `mdoc`, these manpages use semantic markup. This file provides a guideline on where to apply which of the semantic elements of `mdoc`.

     

       59
       59
       +
       

     

       60
       60
       +
       ### Command lines and arguments {#ssec-contributing-nixos-tools-cli-and-args}

     

       61
       61
       +
       

     

       62
       62
       +
       In any manpage, commands, flags and arguments to the *current* executable should be marked according to their semantics. Commands, flags and arguments passed to *other* executables should not be marked like this and should instead be considered as code examples and marked with `Ql`.

     

       63
       63
       +
       

     

       64
       64
       +
       - Use `Fl` to mark flag arguments, `Ar` for their arguments.

     

       65
       65
       +
       - Repeating arguments should be marked by adding ellipses (`...`).

     

       66
       66
       +
       - Use `Cm` to mark literal string arguments, e.g. the `boot` command argument passed to `nixos-rebuild`.

     

       67
       67
       +
       - Optional flags or arguments should be marked with `Op`. This includes optional repeating arguments.

     

       68
       68
       +
       - Required flags or arguments should not be marked.

     

       69
       69
       +
       - Mutually exclusive groups of arguments should be enclosed in curly brackets, preferably created with `Bro`/`Brc` blocks.

     

       70
       70
       +
       

     

       71
       71
       +
       When an argument is used in an example it should be marked up with `Ar` again to differentiate it from a constant. For example, a command with a `--host name` flag that calls ssh to retrieve the host's local time would signify this thusly:

     

       72
       72
       +
       ```

     

       73
       73
       +
       This will run

     

       74
       74
       +
       .Ic ssh Ar name Ic time

     

       75
       75
       +
       to retrieve the remote time.

     

       76
       76
       +
       ```

     

       77
       77
       +
       

     

       78
       78
       +
       ### Paths, NixOS options, environment variables {#ssec-contributing-nixos-tools-options-and-environment}

     

       79
       79
       +
       

     

       80
       80
       +
       Constant paths should be marked with `Pa`, NixOS options with `Va`, and environment variables with `Ev`.

     

       81
       81
       +
       

     

       82
       82
       +
       Generated paths, e.g. `result/bin/run-hostname-vm` (where `hostname` is a variable or arguments) should be marked as `Ql` inline literals with their variable components marked appropriately.

     

       83
       83
       +
       

     

       84
       84
       +
        - Taking `hostname` from an argument become `.Ql result/bin/run- Ns Ar hostname Ns -vm`

     

       85
       85
       +
        - Taking `hostname` from a variable otherwise defined becomes `.Ql result/bin/run- Ns Va hostname Ns -vm`

     

       86
       86
       +
       

     

       87
       87
       +
       ### Code examples and other commands {#ssec-contributing-nixos-tools-code-examples}

     

       88
       88
       +
       

     

       89
       89
       +
       In free text names and complete invocations of other commands (e.g. `ssh` or `tar -xvf src.tar`) should be marked with `Ic`, fragments of command lines should be marked with `Ql`.

     

       90
       90
       +
       

     

       91
       91
       +
       Larger code blocks or those that cannot be shown inline should use indented literal display block markup for their contents, i.e.

     

       92
       92
       +
       

     

       93
       93
       +
       ```

     

       94
       94
       +
       .Bd -literal -offset indent

     

       95
       95
       +
       ...

     

       96
       96
       +
       .Ed

     

       31
       97
        
       ```

     

       32
       98
        
       

     

       33
       33
       -
       If you're on a different architecture that's supported by NixOS (check nixos/release.nix) then replace `x86_64-linux` with the architecture.

     

       34
       34
       -
       `nix-build` will complain otherwise, but should also tell you which architecture you have + the supported ones.

     

       99
       99
       +
       Contents of code blocks may be marked up further, e.g. if they refer to arguments that will be substituted into them:

     

       35
       100
        
       

     

       36
       36
       -
       [DocBook]: https://en.wikipedia.org/wiki/DocBook

     

       101
       101
       +
       ```

     

       102
       102
       +
       .Bd -literal -offset indent

     

       103
       103
       +
       {

     

       104
       104
       +
         options.hostname = "\c

     

       105
       105
       +
       .Ar hostname Ns \c

     

       106
       106
       +
       ";

     

       107
       107
       +
       }

     

       108
       108
       +
       .Ed

     

       109
       109
       +
       ```

+1 -1

nixos/doc/manual/default.nix

···

       185
       185
        
       

     

       186
       186
        
       

     

       187
       187
        
         # Generate the configuration.nix manual package

     

       188
       188
       -
         configuration-manual = runCommand "nixos-manpages"

     

       188
       188
       +
         nixos-configuration-reference-manpage = runCommand "nixos-configuration-reference-manpage"

     

       189
       189
        
           { nativeBuildInputs = [

     

       190
       190
        
               buildPackages.installShellFiles

     

       191
       191
        
               buildPackages.nixos-render-docs

-57

nixos/modules/installer/tools/manpages/README.md

···

       1
       1
       -
       # NixOS manpages

     

       2
       2
       -
       

     

       3
       3
       -
       This is the collection of NixOS manpages, excluding `configuration.nix(5)`.

     

       4
       4
       -
       

     

       5
       5
       -
       Man pages are written in [`mdoc(7)` format](https://mandoc.bsd.lv/man/mdoc.7.html) and should be portable between mandoc and groff for rendering (though minor differences may occur, mandoc and groff seem to have slightly different spacing rules.)

     

       6
       6
       -
       

     

       7
       7
       -
       For previewing edited files, you can just run `man -l path/to/file.8` and you will see it rendered.

     

       8
       8
       -
       

     

       9
       9
       -
       Being written in `mdoc` these manpages use semantic markup. This file provides a guideline on where to apply which of the semantic elements of `mdoc`.

     

       10
       10
       -
       

     

       11
       11
       -
       ### Command lines and arguments

     

       12
       12
       -
       

     

       13
       13
       -
       In any manpage, commands, flags and arguments to the *current* executable should be marked according to their semantics. Commands, flags and arguments passed to *other* executables should not be marked like this and should instead be considered as code examples and marked with `Ql`.

     

       14
       14
       -
       

     

       15
       15
       -
        - Use `Fl` to mark flag arguments, `Ar` for their arguments.

     

       16
       16
       -
        - Repeating arguments should be marked by adding ellipses (`...`).

     

       17
       17
       -
        - Use `Cm` to mark literal string arguments, e.g. the `boot` command argument passed to `nixos-rebuild`.

     

       18
       18
       -
        - Optional flags or arguments should be marked with `Op`. This includes optional repeating arguments.

     

       19
       19
       -
        - Required flags or arguments should not be marked.

     

       20
       20
       -
        - Mutually exclusive groups of arguments should be enclosed in curly brackets, preferably created with `Bro`/`Brc` blocks.

     

       21
       21
       -
       

     

       22
       22
       -
       When an argument is used in an example it should be marked up with `Ar` again to differentiate it from a constant. For example, a command with a `--host name` flag that calls ssh to retrieve the host's local time would signify this thusly:

     

       23
       23
       -
       ```

     

       24
       24
       -
       This will run

     

       25
       25
       -
       .Ic ssh Ar name Ic time

     

       26
       26
       -
       to retrieve the remote time.

     

       27
       27
       -
       ```

     

       28
       28
       -
       

     

       29
       29
       -
       ### Paths, NixOS options, environment variables

     

       30
       30
       -
       

     

       31
       31
       -
       Constant paths should be marked with `Pa`, NixOS options with `Va`, and environment variables with `Ev`.

     

       32
       32
       -
       

     

       33
       33
       -
       Generated paths, e.g. `result/bin/run-hostname-vm` (where `hostname` is a variable or arguments) should be marked as `Ql` inline literals with their variable components marked appropriately.

     

       34
       34
       -
       

     

       35
       35
       -
        - Taking `hostname` from an argument become `.Ql result/bin/run- Ns Ar hostname Ns -vm`

     

       36
       36
       -
        - Taking `hostname` from a variable otherwise defined becomes `.Ql result/bin/run- Ns Va hostname Ns -vm`

     

       37
       37
       -
       

     

       38
       38
       -
       ### Code examples and other commands

     

       39
       39
       -
       

     

       40
       40
       -
       In free text names and complete invocations of other commands (e.g. `ssh` or `tar -xvf src.tar`) should be marked with `Ic`, fragments of command lines should be marked with `Ql`.

     

       41
       41
       -
       

     

       42
       42
       -
       Larger code blocks or those that cannot be shown inline should use indented literal display block markup for their contents, i.e.

     

       43
       43
       -
       ```

     

       44
       44
       -
       .Bd -literal -offset indent

     

       45
       45
       -
       ...

     

       46
       46
       -
       .Ed

     

       47
       47
       -
       ```

     

       48
       48
       -
       Contents of code blocks may be marked up further, e.g. if they refer to arguments that will be substituted into them:

     

       49
       49
       -
       ```

     

       50
       50
       -
       .Bd -literal -offset indent

     

       51
       51
       -
       {

     

       52
       52
       -
         options.hostname = "\c

     

       53
       53
       -
       .Ar hostname Ns \c

     

       54
       54
       -
       ";

     

       55
       55
       -
       }

     

       56
       56
       -
       .Ed

     

       57
       57
       -
       ```

+1 -1

nixos/modules/misc/documentation.nix

···

       346
       346
        
             system.build.manual = manual;

     

       347
       347
        
       

     

       348
       348
        
             environment.systemPackages = []

     

       349
       349
       -
               ++ optional cfg.man.enable manual.configuration-manual

     

       349
       349
       +
               ++ optional cfg.man.enable manual.nixos-configuration-reference-manpage

     

       350
       350
        
               ++ optionals cfg.doc.enable [ manual.manualHTML nixos-help ];

     

       351
       351
        
           })

     

       352
       352

+1 -1

nixos/release.nix

···

       143
       143
        
         manualHTML = buildFromConfig ({ ... }: { }) (config: config.system.build.manual.manualHTML);

     

       144
       144
        
         manual = manualHTML; # TODO(@oxij): remove eventually

     

       145
       145
        
         manualEpub = (buildFromConfig ({ ... }: { }) (config: config.system.build.manual.manualEpub));

     

       146
       146
       -
         manpages = buildFromConfig ({ ... }: { }) (config: config.system.build.manual.configuration-manual);

     

       146
       146
       +
         nixos-configuration-reference-manpage = buildFromConfig ({ ... }: { }) (config: config.system.build.manual.nixos-configuration-reference-manpage);

     

       147
       147
        
         options = (buildFromConfig ({ ... }: { }) (config: config.system.build.manual.optionsJSON)).x86_64-linux;

     

       148
       148
        
       

     

       149
       149

+1 -1

pkgs/tools/nix/nixos-install-tools/default.nix

···

       20
       20
        
           inherit (config.system.build)

     

       21
       21
        
             nixos-install nixos-generate-config nixos-enter;

     

       22
       22
        
       

     

       23
       23
       -
           inherit (config.system.build.manual) configuration-manual;

     

       23
       23
       +
           inherit (config.system.build.manual) nixos-configuration-reference-manpage;

     

       24
       24
        
         };

     

       25
       25
        
       

     

       26
       26
        
         extraOutputsToInstall = ["man"];