From: Lucas De Marchi <lucas.demarchi@intel.com>
To: Emil Velikov <emil.l.velikov@gmail.com>
Cc: <linux-modules@vger.kernel.org>
Subject: Re: [PATCH kmod] man: silence autoconf warnings
Date: Mon, 29 Apr 2024 16:45:00 -0500 [thread overview]
Message-ID: <ngw3fdsrhrggciujgposlrimsoe5a4opbr6d32smr7ebx6gj6z@jxryfcashci4> (raw)
In-Reply-To: <CACvgo53NkaRHbgBkWbiDwSKfUXGRDqV48-zD_NyakjqxUjF8Yg@mail.gmail.com>
On Fri, Feb 23, 2024 at 11:05:24AM GMT, Emil Velikov wrote:
>On Tue, 20 Feb 2024 at 21:56, Lucas De Marchi <lucas.demarchi@intel.com> wrote:
>>
>> On Sat, Feb 17, 2024 at 04:01:26PM +0000, Emil Velikov via B4 Relay wrote:
>> >From: Emil Velikov <emil.l.velikov@gmail.com>
>> >
>> >Currently we have a pattern rule, which effective states that two output
>> >files are produced - %.5 and %.8. Although that's not the case in
>> >practise, since each input xml will be generated to a single manual
>> >page.
>> >
>> >Add the manpage section as part of the xml filename and tweak the
>> >pattern (match) rule, accordingly.
>> >
>> >Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
>> >---
>> >Noticed, while wondering if I should add sanitizer support to the
>> >autoconf build.
>> >
>> >A few, random questions:
>> > - are there any objections to adding sanitizers support?
>>
>> no
>>
>> > - would a meson.build be acceptable? Giving us sanitizers, coverage,
>> > scan-build, etc out of the box
>>
>> yes. A few years ago we converted to meson but I think a few things were
>> not working properly and we never finished that. If you few like adding
>> that for the next version, feel free to use that as base:
>>
>> https://github.com/falconindy/kmod.git meson
>>
>> > - writing xml is fiddly, would people be OK if we convert them to
>> > scdoc? here are some examples of the raw file [1] vs the man [2]
>>
>> first time I hear about scdoc. syntax seems simple, but I do wonder how
>> common it is in distros compared to e.g. pandoc or other options to
>> produce manpages.
>>
>> I know mkosi writes markdown and converts that to a manpage
>> (https://github.com/systemd/mkosi) and dim uses rst2man
>> (https://gitlab.freedesktop.org/drm/maintainer-tools.git)
>>
>> Any of those options seems better than writing xml, so I won't oppose to
>> scdoc if it's available in multiple distros out of the box in a version
>> that is sufficient for us.
>>
>
>Neat, thanks for the input and pointers. Will do some digging and
>provide a summary wrt scdoc/rst2man
did you get a chance to try those? TIL igt also uses rst2man for its
tools
(https://gitlab.freedesktop.org/drm/igt-gpu-tools/-/tree/master/man?ref_type=heads)
so I think it would be the preferred one.
thanks
Lucas De Marchi
>
>-Emil
next prev parent reply other threads:[~2024-04-29 21:45 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-17 16:01 [PATCH kmod] man: silence autoconf warnings Emil Velikov via B4 Relay
2024-02-20 21:56 ` Lucas De Marchi
2024-02-23 11:05 ` Emil Velikov
2024-04-29 21:45 ` Lucas De Marchi [this message]
2024-04-30 18:18 ` Emil Velikov
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=ngw3fdsrhrggciujgposlrimsoe5a4opbr6d32smr7ebx6gj6z@jxryfcashci4 \
--to=lucas.demarchi@intel.com \
--cc=emil.l.velikov@gmail.com \
--cc=linux-modules@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).