nixos/mandoc: init; nixos/documentation: refactor #139333
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
6.topic: nixos
ofborg
bot
added
11.by: package-maintainer
12 tasks
sternenseemann
force-pushed
the
mandoc-module
branch
4 times, most recently
from
d8e88e3 to
103e4c8
Compare
sternenseemann
changed the title
|
@ofborg test man |
bb010g
reviewed
Sep 25, 2021
sternenseemann
force-pushed
the
mandoc-module
branch
from
103e4c8 to
de69943
Compare
Closed
sternenseemann
force-pushed
the
mandoc-module
branch
from
de69943 to
1c31ada
Compare
sternenseemann
force-pushed
the
mandoc-module
branch
2 times, most recently
from
b300e7b to
9b97e43
Compare
bb010g
suggested changes
Nov 5, 2021
sternenseemann
force-pushed
the
mandoc-module
branch
from
9b97e43 to
903fbdf
Compare
ofborg
bot
added
2.status: merge conflict
sternenseemann
force-pushed
the
mandoc-module
branch
from
2fbbc63 to
f894a4a
Compare
github-actions
bot
added
8.has: changelog
8.has: documentation
sternenseemann
force-pushed
the
mandoc-module
branch
from
f894a4a to
ef9cca2
Compare
|
@ofborg test man |
Profpatsch
requested changes
Nov 24, 2021
sternenseemann
force-pushed
the
mandoc-module
branch
from
629fdd3 to
9cc8308
Compare
It may be possible to revert the move of `documentation.man.manualPages` later. The problem is that other man implementations (mandoc) want to generate their index databases in place, so the approach taken here doesn't translate super well.
man -k is useful to mention as it is -- in constrast to apropos(1) -- actually required by POSIX.
Adds a NixOS module which allows using mandoc as the main manual viewer. It can be used as a drop-in replacement for documentation.man which relies on GNU's man-db and provides more or less the same features. The generateCaches option requires a different implementation for mandoc, so it is hard to share code between the two modules -- hence it has been implemented separately. Using both at the same time makes little sense and wouldn't quite work, so there's an assertion to prevent it. To make makewhatis(8) index manual pages which are symlinks to the nix store, we need to set READ_ALLOWED_PATH to include `builtins.storeDir`. For background and discussion see: https://inbox.vuxu.org/mandoc-tech/c9932669-e9d4-1454-8708-7c8e36967e8e@systemli.org/T/
sternenseemann
force-pushed
the
mandoc-module
branch
from
9cc8308 to
1b4aa04
Compare
Profpatsch
approved these changes
Dec 30, 2021
|
|
|
That doesn’t work as it needs to be able to write to that path for generateCaches iirc.
… On 2. Jan 2022, at 20:50, Naïm Favier ***@***.***> wrote:
mandoc.manPath should probably accept absolute paths too, for man pages outside of /run/current-system/sw.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications on the go with GitHub Mobile for iOS or Android.
You are receiving this because you modified the open/close state.
|
|
A quick note in case you're interested: for me, switching configuration.nix to mandoc broke access to |
|
That is indeed an oversight, I'll open an issue for that. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for this change
TODO:
Things done
sandbox = trueset innix.conf? (See Nix manual)nix-shell -p nixpkgs-review --run "nixpkgs-review wip"./result/bin/)