From: Felipe Contreras <email@example.com> To: "brian m. carlson" <firstname.lastname@example.org>, Felipe Contreras <email@example.com> Cc: "Jeff King" <firstname.lastname@example.org>, "Martin Ågren" <email@example.com>, "Bagas Sanjaya" <firstname.lastname@example.org>, "Git Users" <email@example.com> Subject: Re: [RFC suggestion] Generate manpage directly with Asciidoctor Date: Tue, 11 May 2021 20:44:40 -0500 [thread overview] Message-ID: <firstname.lastname@example.org> (raw) In-Reply-To: <YJsPuU5eLO8TkY2L@camp.crustytoothpaste.net> brian m. carlson wrote: > On 2021-05-11 at 04:27:54, Felipe Contreras wrote: > > I've never understood developers worried about how the bleeding edge > > would build in ancient platforms, when ancient platforms don't care > > about the bleeding edge. > > Debian stable is a common environment to do development on. I know > people who do use it for Git development, so I suspect we'll want to > continue to support it. I didn't mean to suggest otherwise. > Yes, people _can_ run "gem install asciidoctor", but people who are not > Ruby developers generally would prefer a distro package over installing > one-off gems, especially since getting the binaries into PATH is tricky > with gem. Yes, but there's only so much we can hold hands with our users. If a user: 1. Uses an acient distribution 2. Wants to build the documentation 3. Enables USE_ASCIIDOCTOR 4. Doesn't know Ruby 5. Wants to use distribution packages 6. Is bothered by the output I think it's valid for the project to say "you are on your own". In fact, not really that because if they contact the mailing list we would help them. The only thing we could do is print a warning if they try to build with versions of asciidoctor that we know are problematic. That being said; it's not "tricky" to get binaries into your PATH: export PATH="$GEM_HOME/bin:$PATH" And you don't need to get gem binaries into your PATH: export GEM_HOME=/tmp/gems gem install asciidoctor make USE_ASCIIDOCTOR=YesPlease ASCIIDOC=$GEM_HOME/bin/asciidoctor doc Works just fine without modifying PATH. > > > It's not too hard to install an updated gem, but not quite as nice as > > > using the system package (it also makes things weird for building the > > > stable Debian package itself, which would want to rely only on other > > > packages; but of course any proposed change to the doc toolchain would > > > be for new versions, and would not get backported there anyway). > > > > Anyone trying to build git master on top of Debian stable 1. probably > > can live with the output of the current doc toolchain, and 2. probably > > doesn't exist. > > I believe I have just demonstrated that 2 is false above. I meant trying to build the documentation of git on git master. > > > > I think what I'm arguing for is > > > > > > > > 1) switch the default to asciidoctor, > > > > 2) enable optionally using it without xmlto, > > > > 3) figure out what broke and fix it, and document which is the minimum > > > > asciidoctor version we're going to bother with for (2), > > > > 4) lather, rinse, repeat (3), > > > > 5) switch the default to not using xmlto, > > > > 6) drop the xmlto way of generating the manpages(?). > > > > > > I'm unclear when support for python asciidoc goes away here. Is it part > > > of step 6 (because it does not have another way of generating them)? Or > > > does it live on forever as a non-default legacy system? I'd prefer not, > > > but as long as we are clear about the primary target and leave it up to > > > people interested in the legacy to do the compat fixes, that might be > > > OK. > > > > How about we leave the legacy system in place as an alternative, and > > decide later what to do with it? > > I think it would be fine to just leave it in place for now and let > people decide which toolchain they'd like to use. Agreed. -- Felipe Contreras
next prev parent reply other threads:[~2021-05-12 1:44 UTC|newest] Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-05-07 6:06 Bagas Sanjaya 2021-05-07 12:02 ` Randall S. Becker 2021-05-07 22:55 ` Felipe Contreras 2021-05-07 22:57 ` brian m. carlson 2021-05-08 1:42 ` Randall S. Becker 2021-05-07 12:27 ` Đoàn Trần Công Danh 2021-05-07 12:47 ` Bagas Sanjaya 2021-05-07 23:03 ` Felipe Contreras 2021-05-08 4:27 ` Bagas Sanjaya 2021-05-07 20:25 ` brian m. carlson 2021-05-07 22:19 ` Jeff King 2021-05-08 4:22 ` Bagas Sanjaya 2021-05-09 8:20 ` Martin Ågren 2021-05-09 18:46 ` Felipe Contreras 2021-05-10 18:43 ` Martin Ågren 2021-05-10 22:24 ` Jeff King 2021-05-11 4:27 ` Felipe Contreras 2021-05-11 6:13 ` Jeff King 2021-05-11 8:03 ` Felipe Contreras 2021-05-11 12:44 ` Ævar Arnfjörð Bjarmason 2021-05-11 19:00 ` Felipe Contreras 2021-05-11 19:09 ` Jeff King 2021-05-11 20:22 ` Felipe Contreras 2021-05-11 23:14 ` brian m. carlson 2021-05-12 1:44 ` Felipe Contreras [this message] 2021-05-11 18:45 ` Martin Ågren 2021-05-11 19:07 ` Jeff King 2021-05-11 19:11 ` Martin Ågren 2021-05-11 20:14 ` Felipe Contreras 2021-05-11 9:04 ` Jean-Noël Avila 2021-05-11 18:54 ` Martin Ågren 2021-05-07 23:35 ` Felipe Contreras 2021-05-07 23:57 ` brian m. carlson 2021-05-08 3:10 ` Jeff King 2021-05-08 3:23 ` Jeff King 2021-05-09 0:22 ` brian m. carlson 2021-05-09 8:29 ` Martin Ågren 2021-05-07 22:48 ` Felipe Contreras
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style List information: http://vger.kernel.org/majordomo-info.html * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --subject='Re: [RFC suggestion] Generate manpage directly with Asciidoctor' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Code repositories for project(s) associated with this inbox: https://80x24.org/mirrors/git.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).