Skip to content

Option docs improvements#179351

Merged
roberth merged 8 commits intoNixOS:masterfrom
hercules-ci:option-docs-improvements
Jun 27, 2022
Merged

Option docs improvements#179351
roberth merged 8 commits intoNixOS:masterfrom
hercules-ci:option-docs-improvements

Conversation

@roberth
Copy link
Member

@roberth roberth commented Jun 27, 2022

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
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 22.11 Release Notes (or backporting 22.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
    • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
  • Fits CONTRIBUTING.md.

roberth added 7 commits June 27, 2022 17:41
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.
@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation labels Jun 27, 2022
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels Jun 27, 2022
Copy link
Contributor

@pennae pennae left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't know enough about the xslt sheets to comment on those, but the rest looks good. 👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 roberth force-pushed the option-docs-improvements branch from a25cb0f to 7c81905 Compare June 27, 2022 20:07
@roberth
Copy link
Member Author

roberth commented Jun 27, 2022

xslt sheets

No worries, I'm somewhat familiar with them, and I've tested the change.

@roberth roberth merged commit 47dd5d1 into NixOS:master Jun 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments