doc: use asciidoctor instead of a2x #1544
Conversation
|
Seems that replacing |
There was a problem hiding this comment.
Thanks very much! I had no idea that this was the root cause of the Homebrew issue and also had no idea that asciidoc was itself being EOL'd this year.
So one thing that I'm concerned about here is the abrupt switchover to asciidoctor. I think what I'd rather do is to use asciidoctor like you have in this PR, but fallback to a2x if asciidoctor isn't available. That will make it easy to release this change in a point release with a note that a2x support will be removed and man page generation will require asciidoctor in ripgrep 13. That will give package maintainers a bit more slack to deal with this change.
I know it's more of a pain to do that here. Let me know how you'd like to proceed. If you don't do it, then I'd be happy to take over this PR and do it myself, but I don't know when that will be. If you do want to do it, then I'd recommend just having two totally different paths between asciidoc and asciidoctor. No need to try to reuse code between them in build.rs. Then we can just lift out a2x when we're ready.
Thanks again!
ci/macos-install-packages
Outdated
| @@ -1,3 +1,3 @@ | |||
| #!/bin/sh | |||
|
|
|||
| brew install asciidoc docbook-xsl | |||
| brew install asciidoctor docbook-xsl | |||
There was a problem hiding this comment.
I wonder if docbook-xsl is still needed? We can leave it here for now and I'll experiment with it later. IIRC, asciidoc complained when this wasn't installed before. No idea if asciidoctor also needs it.
There was a problem hiding this comment.
I don't think it's needed as when I don't have installed docbook or docbook-xsl, asciidoctor worked. How about Ubuntu packages? Are libxslt1-dev, docbook-xsl, xsltproc, libxml2-utils related only to asciidoc? I'll try running the CI without them.
yous
force-pushed
the
use-asciidoctor
branch
2 times, most recently
from
c26623e
to
79d68f0
Compare
AsciiDoc development is continued under asciidoctor. See https://github.com/asciidoc/asciidoc.
|
I renamed the original |
BurntSushi
added
the
rollup
AsciiDoc development is continued under asciidoctor. See https://github.com/asciidoc/asciidoc. We do however fallback to a2x if asciidoctor is not present. This is to ease migration, but at some point, it's likely that support for a2x will be dropped. Originally reported downstream: https://github.com/Homebrew/linuxbrew-core/issues/19885 Closes #1544
Ref: Homebrew/linuxbrew-core#19885
AsciiDoc development is continued under asciidoctor. See https://github.com/asciidoc/asciidoc.
I tried to run CI several times, but on nightly build, Rust fails to find the asciidoctor binary even
/usr/bin/asciidoctorexists.Attaching
rg.1.asciidocfrom current build, andrg.1.asciidoctorfrom new build.