nixos: doc: implement #12542 #46193
Merged
nixos: doc: implement #12542 #46193
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
vcunat
approved these changes
Sep 14, 2018
oxij
force-pushed
the
nixos/manual-to-doc
branch
from
233ef0a
to
8c4ea26
Compare
samueldr
reviewed
Sep 23, 2018
nixos/modules/misc/documentation.nix
Outdated
| <citerefentry><refentrytitle>configuration.nix</refentrytitle> | ||
| <manvolnum>5</manvolnum></citerefentry> if <option>man.enable</option> is | ||
| set.</para></listitem> | ||
| <listitem><para>This includes HTML manual and <command>nixos-help</command> script if |
There was a problem hiding this comment.
I think this should be phrased "This includes the HTML manual and the nixos-help [...]". Additionally, the end-user wouldn't care much whether it is a script or a binary. "the nixos-help command" represents better what the end-user would use; a command.
(The previous sentence "This includes man pages like [...]", though is fine without adding "the".)
|
For those wondering what the XML in the
This will be different, yet similar on the NixOS website. |
|
Status: this conflicts with merged #46510 and I have questions about that change there, so this is now stalled. |
Because when I see "config.system.build.manual.manual" after I forgot what it means I ask "Why do I need that second `.manual` there again?". Doesn't happen with `config.system.build.manual.manualHTML`.
oxij
force-pushed
the
nixos/manual-to-doc
branch
from
8c4ea26
to
0f3b89b
Compare
|
Fixed nitpicks. Fixed conflicts and rebased. |
samueldr
approved these changes
Sep 24, 2018
|
Error update NixOS with --show-trace |
|
Please show the output of `grep nixosManual configuration.nix` (and/or all equivalent files).
It looks like you have `services.nixosManual.enable` disabled but `services.nixosManual.showManual` enabled and the new `assert` gets computed too late for some reason.
|
|
Not found nixosManual in /etc/nixos/* |
1 task
|
Indeed, I reproduced your error it with a minimal config with the above combination of options, so evaluation order is indeed buggy, fixed in #47293. Now the question is what sets this combination of variables in your config. Do you include any profiles? (In principle, I can "fix" this by simply disabling |
|
This config causes an error |
|
Should be fixed by #47298. |
7c6f434c
added a commit
that referenced
this pull request
Sep 25, 2018
nixos: fix fallout from #46193
oxij
referenced
this pull request
Sep 25, 2018
Introduced by 0f3b89b. If services.nixosManual.showManual is enabled and documentation.nixos.enable is not, there is no config.system.build.manual available, so evaluation fails. For example this is the case for the installer tests. There is however an assertion which should catch exactly this, but it isn't thrown because the usage of config.system.build.manual is evaluated earlier than the assertions. So I split the assertion off into a separate mkIf to make sure it is shown appropriately and also fixed the installation-device profile to enable documentation.nixos. Signed-off-by: aszlig <aszlig@nix.build> Cc: @oxij
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
NixOS
documentationsubtree was born out of 2/3s of #12542, this implements the leftover 1/3. This patchset consists of option renames, code movements, a bit of cleanup, and one new assert.In short, nothing substantial.
This simply makes the
configuration.nix(5)manual cleaner and theservices.nixosManualservice is now actually a service, not an amalgamation of different things.Known issues
services.nixosManual.showManualshould be renamed toservices.nixosManual.enable, but sinceservices.nixosManual.enablemeant a completely different thing before and there's noconfigVersion-thing yet I left it as is.Things done
Don't merge sooner than 2018-09-09 23:59 UTC.