From: Jonathan Corbet <corbet@lwn.net>
To: Dimitri John Ledkov <dimitri.ledkov@canonical.com>,
linux-doc@vger.kernel.org
Cc: linux-perf-users@vger.kernel.org, kvm@vger.kernel.org
Subject: Re: Converting manpages from asciidoc to rst2man ?
Date: Mon, 04 Dec 2023 07:36:04 -0700 [thread overview]
Message-ID: <87fs0iujaj.fsf@meer.lwn.net> (raw)
In-Reply-To: <CADWks+Z=kLTohq_3pk_PdXs54B6tLn25u6avn_Q1FyXN2-sVDQ@mail.gmail.com>
Dimitri John Ledkov <dimitri.ledkov@canonical.com> writes:
> Hi all,
>
> I was going through build-depends on linux kernel in Ubuntu and I
> noticed that whilst most documentation and man-pages are written in
> Rst format, there are a few that require asciidoc.
>
> $ git grep -l asciidoc -- '*Makefile*'
> tools/kvm/kvm_stat/Makefile
> tools/lib/perf/Documentation/Makefile
> tools/perf/Documentation/Makefile
> tools/perf/Makefile.perf
Interesting...I was unaware of those...
> Are both Rst and asciidoc preferred in the kernel Documentation? Or
> should we upgrade kvm_stat & perf manpages from asciidoc to rst2man?
In general we don't have a lot of man pages in the kernel, so it's not
something we've put a lot of thought into. Ideally, I suppose, it would
be nice to get all of those man pages integrated into the RST docs
build, but it's not something that is likely to inspire any great sense
of urgency.
Thanks,
jon
next prev parent reply other threads:[~2023-12-04 14:36 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-04 14:25 Converting manpages from asciidoc to rst2man ? Dimitri John Ledkov
2023-12-04 14:36 ` Jonathan Corbet [this message]
2023-12-04 21:21 ` Ian Rogers
2023-12-05 4:01 ` Theodore Ts'o
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87fs0iujaj.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=dimitri.ledkov@canonical.com \
--cc=kvm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-perf-users@vger.kernel.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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 NNTP newsgroup(s).