Option docs improvements #179351
Merged
Option docs improvements #179351
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
By writing the unchecked outputs before checking them, they will be written to a store path, which appears in the log, and which sticks around even if the build fails. Eventually it is GCed, but until then, you can open the file. If you run it in a terminal+editor combination like VSCode, the failure location is just one Ctrl+click away.
I've tried XInclude set-xml-id first, but our tooling did not pick up on it.
This occurs in the ast generated for blockquotes.
Our tooling would trip without the inner <para>, despite the docbook docs suggesting that <para> occurs in <blockquote> and vice versa.
This was referenced Jun 27, 2022
pennae
reviewed
Jun 27, 2022
| def block_code(self, text, info=None): | ||
| info = f" language={quoteattr(info)}" if info is not None else "" | ||
| return f"<programlisting{info}>\n{text}</programlisting>" | ||
| if info == "{=docbook}": |
There was a problem hiding this comment.
not sure having that hatch is such a great thing. we'll have to make some adjustment to the documentation to get it to work as markdown anyway, and if we have a hatch we have one more place to keep in mind when we finally axe docbook.
do you have a special use in mind where this is necessary? maybe a few more extension to the renderer would be better.
There was a problem hiding this comment.
I used it while I couldn't get blockquote accepted by the docbook tooling that runs after this. I suppose I could have used a plain old docbook description instead. I'll remove it.
Feature was introduced in NixOS#174460, but wasn't supported in `mergeJSON.py` yet.
roberth
force-pushed
the
option-docs-improvements
branch
from
a25cb0f
to
7c81905
Compare
No worries, I'm somewhat familiar with them, and I've tested the change. |
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.
Description of changes
Some improvements I've found while working on the NixOS test framework (#176557). They're small fixes and quality of life improvements.
Things done
sandbox = trueset innix.conf? (See Nix manual)nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)nixos/doc/manual/md-to-db.shto update generated release notes