New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
nixos/manual: warn on missing xml:id #55396
Conversation
@@ -265,6 +265,7 @@ in rec { | |||
xsltproc \ | |||
${manualXsltprocOptions} \ | |||
--stringparam target.database.document "${olinkDB}/olinkdb.xml" \ | |||
--stringparam id.warnings "1" \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're my hero for this. Maybe better to extend this list:
nixpkgs/nixos/doc/manual/default.nix
Line 132 in 4c0230e
manualXsltprocOptions = toString [ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, this seems to only impact HTML documents. But adding it to the global options may be better if someone only tests it with some other version without generating the HTML. Not too sure really. What do you think ?
Make sense. Let’s do it as is.
…Sent from my iPhone
On Feb 7, 2019, at 10:43, Guillaume Maudoux ***@***.***> wrote:
@layus commented on this pull request.
In nixos/doc/manual/default.nix:
> @@ -265,6 +265,7 @@ in rec {
xsltproc \
${manualXsltprocOptions} \
--stringparam target.database.document "${olinkDB}/olinkdb.xml" \
+ --stringparam id.warnings "1" \
Well, this seems to only impact HTML documents. But adding it to the global options may be better if someone only tests it with some other version without generating the HTML. Not too sure really. What do you think ?
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep this makes sense to warn about even without the reproducibility issue.
In order to keep the manual reproducible, we need to avoid randomly
generated ids. This patch enables warning on missing ids.
A further step could turn them to errors, but the case of
partintro
blocks needs to be solved first.
See #55375