Ambiguous item in documentation of `nix.conf` #516

New issue

Open

opened 2024-09-12 18:40:11 +00:00 by jalil-salame · 0 comments

jalil-salame commented

2024-09-12 18:40:11 +00:00

Problem

In the man 5 nix.conf source it states:

Otherwise it will look for nix/nix.conf files in XDG_CONFIG_DIRS and XDG_CONFIG_HOME.

Unlike in the previous item, here it doesn't specify the order in which the files are read:

If NIX_USER_CONF_FILES is set, then each path separated by : will be loaded in reverse order.

My assumption is that they are also loaded in reverse order, but I don't have the energy to double check.

Proposal

Reword the documentation to be explicit about the reading order, e.g.:

Otherwise it will look for nix/nix.conf files in XDG_CONFIG_DIRS (also in reverse order, like with NIX_USER_CONF_FILES) and then in XDG_CONFIG_HOME.

Checklist

checked latest Lix manual
checked documentation issues and recent documentation changes for possible duplicates

## Problem In the [`man 5 nix.conf`](https://git.lix.systems/lix-project/lix/src/commit/b2fc007811a5afc473bf116fe8d38688b3699e25/doc/manual/src/command-ref/conf-file.md?display=source#L9-L23) source it states: > Otherwise it will look for `nix/nix.conf` files in `XDG_CONFIG_DIRS` and `XDG_CONFIG_HOME`. Unlike in the previous item, here it doesn't specify the order in which the files are read: > If `NIX_USER_CONF_FILES` is set, then each path separated by `:` will be loaded in reverse order. My assumption is that they are also loaded in reverse order, but I don't have the energy to double check. ## Proposal Reword the documentation to be explicit about the reading order, e.g.: > Otherwise it will look for `nix/nix.conf` files in `XDG_CONFIG_DIRS` (also in reverse order, like with `NIX_USER_CONF_FILES`) and then in `XDG_CONFIG_HOME`. ## Checklist  - [x] checked [latest Lix manual][source] - [x] checked [documentation issues] and [recent documentation changes] for possible duplicates [latest Nix manual]: https://docs.lix.systems/manual/lix/nightly [source]: https://git.lix.systems/lix-project/lix/src/main/doc/manual/src [documentation issues]: https://git.lix.systems/lix-project/lix/issues?labels=151&state=all [recent documentation changes]: https://gerrit.lix.systems/q/p:lix+path:%22%5Edoc/manual/.*%22