Unverified Commit b36f8e0b authored by h7x4's avatar h7x4
Browse files

various: add `{file}` tags for nixos option descriptions

parent c96a4994

nixos/modules/config/users-groups.nix

+1 −1
Original line number Diff line number Diff line
@@ -464,7 +464,7 @@ let 
            Whether to enable or disable lingering for this user.  Without

            lingering, user units will not be started until the user logs in,

            and may be stopped on logout depending on the settings in

            `logind.conf`.

            {file}`logind.conf`.



            By default, NixOS will not manage lingering, new users will default

            to not lingering, and lingering can be configured imperatively using

nixos/modules/config/xdg/portal.nix

+3 −3
Original line number Diff line number Diff line
@@ -91,8 +91,8 @@ in 
        Sets which portal backend should be used to provide the implementation

        for the requested interface. For details check {manpage}`portals.conf(5)`.



        Configs will be linked to `/etc/xdg/xdg-desktop-portal/` with the name `$desktop-portals.conf`

        for `xdg.portal.config.$desktop` and `portals.conf` for `xdg.portal.config.common`

        Configs will be linked to {file}`/etc/xdg/xdg-desktop-portal/` with the name {file}`$desktop-portals.conf`

        for {file}`xdg.portal.config.$desktop` and {file}`portals.conf` for {file}`xdg.portal.config.common`

        as an exception.

      '';

    };
@@ -103,7 +103,7 @@ in 
      example = lib.literalExpression "[ pkgs.gnome-session ]";

      description = ''

        List of packages that provide XDG desktop portal configuration, usually in

        the form of `share/xdg-desktop-portal/$desktop-portals.conf`.

        the form of {file}`share/xdg-desktop-portal/$desktop-portals.conf`.



        Note that configs in `xdg.portal.config` will be preferred if set.

      '';

nixos/modules/programs/starship.nix

+1 −1
Original line number Diff line number Diff line
@@ -60,7 +60,7 @@ in 
      inherit (settingsFormat) type;

      default = { };

      description = ''

        Configuration included in `starship.toml`.

        Configuration included in {file}`starship.toml`.



        See <https://starship.rs/config/#prompt> for documentation.

      '';

nixos/modules/services/amqp/rabbitmq.nix

+2 −2
Original line number Diff line number Diff line
@@ -100,7 +100,7 @@ in 
        description = ''

          Configuration options in RabbitMQ's new config file format,

          which is a simple key-value format that can not express nested

          data structures. This is known as the `rabbitmq.conf` file,

          data structures. This is known as the {file}`rabbitmq.conf` file,

          although outside NixOS that filename may have Erlang syntax, particularly

          prior to RabbitMQ 3.7.0.
@@ -119,7 +119,7 @@ in 
        type = lib.types.str;

        description = ''

          Verbatim advanced configuration file contents using the Erlang syntax.

          This is also known as the `advanced.config` file or the old config format.

          This is also known as the {file}`advanced.config` file or the old config format.



          `configItems` is preferred whenever possible. However, nested

          data structures can only be expressed properly using the `config` option.

nixos/modules/services/computing/slurm/slurm.nix

+7 −7
Original line number Diff line number Diff line
@@ -143,7 +143,7 @@ in 
          type = lib.types.lines;

          default = "";

          description = ''

            Extra configuration for `slurmdbd.conf` See also:

            Extra configuration for {file}`slurmdbd.conf` See also:

            {manpage}`slurmdbd.conf(8)`.

          '';

        };
@@ -196,7 +196,7 @@ in 
        type = lib.types.bool;

        default = false;

        description = ''

          Whether to provide a slurm.conf file.

          Whether to provide a {file}`slurm.conf` file.

          Enable this option if you do not run a slurm daemon on this host

          (i.e. `server.enable` and `client.enable` are `false`)

          but you still want to run slurm commands from this host.
@@ -332,7 +332,7 @@ in 
          default = "";

          type = lib.types.lines;

          description = ''

            Extra configuration for that will be added to `mpi.conf`.

            Extra configuration for that will be added to {file}`mpi.conf`.

          '';

        };

      };
@@ -341,7 +341,7 @@ in 
        default = "";

        type = lib.types.lines;

        description = ''

          Extra configuration that will be added to the end of `plugstack.conf`.

          Extra configuration that will be added to the end of {file}`plugstack.conf`.

        '';

      };
@@ -349,7 +349,7 @@ in 
        default = "";

        type = lib.types.lines;

        description = ''

          Extra configuration for `cgroup.conf`. This file is

          Extra configuration for {file}`cgroup.conf`. This file is

          used when `procTrackType=proctrack/cgroup`.

        '';

      };
@@ -359,9 +359,9 @@ in 
        default = [ ];

        description = ''

          Slurm expects config files for plugins in the same path

          as `slurm.conf`. Add extra nix store

          as {file}`slurm.conf`. Add extra nix store

          paths that should be merged into same directory as

          `slurm.conf`.

          {file}`slurm.conf`.

        '';

      };