From: Stephen Kitt <steve@sk2.org>
To: "Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>
Cc: linux-man@vger.kernel.org, Michael Kerrisk <mtk.manpages@gmail.com>
Subject: Re: [PATCH 4/9] matherr.3: Exclude the example from analysis
Date: Sat, 8 Jan 2022 10:12:09 +0100 [thread overview]
Message-ID: <20220108101209.52a20bab@heffalump.sk2.org> (raw)
In-Reply-To: <681c4772-bbfe-2dae-76f9-d1e130ac16e1@gmail.com>
[-- Attachment #1: Type: text/plain, Size: 1040 bytes --]
Hi Alex,
On Sat, 8 Jan 2022 02:31:42 +0100, "Alejandro Colomar (man-pages)"
<alx.manpages@gmail.com> wrote:
> On 1/7/22 17:46, Stephen Kitt wrote:
> > The example program is obsolete, as indicate in the text, and
> > shouldn't be analysed. Changing the introductory heading to "Obsolete
> > program source" excludes it from automated analysis and makes it
> > hopefully clearer to readers that it is obsolete.
>
> In this case, the first paragraph of the DESCRIPTION already notes that
> the whole page is obsolete (and even removed from glibc). On top of
> that, I plan to add the [[deprecated]] attribute to the function
> prototype in the SYNOPSIS (when Michael comes back).
>
> Do you think it's still necessary to mark the example program obsolete?
> For a human reader, I'd say no.
> For the automated analysis, I'd first decide on which format we want to
> standardize to mark code begin and code end, and after that fix this if
> it needs to be fixed.
I agree, let’s wait.
Regards,
Stephen
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next prev parent reply other threads:[~2022-01-08 9:12 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-07 16:46 [PATCH 1/9] Add a target to check example programs Stephen Kitt
2022-01-07 16:46 ` [PATCH 2/9] seccomp.2: Use syscall() in the example code Stephen Kitt
2022-01-08 1:18 ` Alejandro Colomar (man-pages)
2022-01-07 16:46 ` [PATCH 3/9] inet.3: Switch to _DEFAULT_SOURCE in the example Stephen Kitt
2022-01-08 1:26 ` Alejandro Colomar (man-pages)
2022-01-08 9:06 ` Stephen Kitt
2022-01-07 16:46 ` [PATCH 4/9] matherr.3: Exclude the example from analysis Stephen Kitt
2022-01-08 1:31 ` Alejandro Colomar (man-pages)
2022-01-08 9:12 ` Stephen Kitt [this message]
2022-01-07 16:46 ` [PATCH 5/9] mq_notify.3: Add signal.h for SIGEV_THREAD Stephen Kitt
2022-01-08 1:38 ` Alejandro Colomar (man-pages)
2022-01-07 16:46 ` [PATCH 6/9] newlocale.3: Use LC_GLOBAL_LOCALE, not ..._HANDLE Stephen Kitt
2022-01-08 1:41 ` Alejandro Colomar (man-pages)
2022-01-08 9:13 ` Jakub Wilk
2022-01-08 17:58 ` Alejandro Colomar (man-pages)
2022-01-07 16:46 ` [PATCH 7/9] pkeys.7: Update the example to match glibc Stephen Kitt
2022-01-08 1:59 ` Alejandro Colomar (man-pages)
2022-01-08 14:18 ` Stephen Kitt
2022-01-08 19:20 ` Alejandro Colomar (man-pages)
2022-01-07 16:46 ` [PATCH 8/9] strtok.3: Enable example analysis, fix declaration Stephen Kitt
2022-01-08 2:04 ` Alejandro Colomar (man-pages)
2022-01-07 16:46 ` [PATCH 9/9] malloc_info.3: Use intptr_t to store pointers Stephen Kitt
2022-01-08 2:25 ` Alejandro Colomar (man-pages)
2022-01-08 10:30 ` Jakub Wilk
2022-01-08 17:09 ` Stephen Kitt
2022-01-08 19:17 ` Alejandro Colomar (man-pages)
2022-01-08 1:15 ` [PATCH 1/9] Add a target to check example programs Alejandro Colomar (man-pages)
2022-01-08 9:22 ` Stephen Kitt
2022-01-08 19:05 ` Alejandro Colomar (man-pages)
2022-01-08 19:38 ` Alejandro Colomar (man-pages)
2022-01-08 2:02 ` Alejandro Colomar (man-pages)
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=20220108101209.52a20bab@heffalump.sk2.org \
--to=steve@sk2.org \
--cc=alx.manpages@gmail.com \
--cc=linux-man@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
/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