Re: [PATCH v2] memmem.3: Add list of known systems where this is available

[Alejandro Colomar <alx.manpages@gmail.com>]

[-- Attachment #1.1: Type: text/plain, Size: 3029 bytes --]

Hi Andrew,

On 11/11/22 00:31, Andrew Clayton wrote:
> While looking at which systems provide memmem(3) I have been able to
> discern the following:
> 
>    musl libc since v0.9.7 (2012)
>    bionic since Android 9 (2018)
> 
>    FreeBSD since 6.0 (2005)
>    OpenBSD since 5.4 (2013)
>    NetBSD
>    macOS
>    Illumos
> 
> For macOS and Illumos I checked the memmem(3) man page on those systems.
> For the rest there are links below to on-line man pages or commit logs.
> 
> Where I could determine what version memmem(3) was introduced, I've
> noted that in the man page.
> 
> Link: <http://git.musl-libc.org/cgit/musl/commit/src/string/memmem.c?id=c86f2974e2acd330be2d587173dd4dd56db82e22>
> Link: <https://android.googlesource.com/platform/bionic/+/android-9.0.0_r3/libc/bionic/memmem.cpp>
> Link: <https://www.freebsd.org/cgi/man.cgi?query=memmem&sektion=3&format=html>
> Link: <https://man.openbsd.org/memmem.3>
> Link: <https://anonhg.netbsd.org/src/diff/96a37d536271/common/lib/libc/string/memmem.c>
> Suggested-by: Alejandro Colomar <alx@kernel.org>
> Signed-off-by: Andrew Clayton <andrew@digital-domain.net>
> ---
> 
>   v2:
>    - Remove references to bionic and macOS from the man page
>    - Convert & to and
>    - Use Oxford comma
>    - Add dates where known to the commit message
>    - Use present tense for the subject line

Oh, thanks for this one!  I hadn't realized.  :P

> 
>   man3/memmem.3 | 4 +++-
>   1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/man3/memmem.3 b/man3/memmem.3
> index 134dffab0..cb0d3e195 100644
> --- a/man3/memmem.3
> +++ b/man3/memmem.3
> @@ -58,7 +58,9 @@ T}	Thread safety	MT-Safe
>   .sp 1
>   .SH STANDARDS
>   This function is not specified in POSIX.1,
> -but is present on a number of other systems.
> +but is present on a number of other systems,
> +including: musl libc 0.9.7; FreeBSD 6.0, OpenBSD 5.4,
> +NetBSD, and Illumos.

I've been thinking about the line breaks.  I'm not sure how I'd split them, but 
I'm not happy with the current suggestion.

Please see man-pages(7) about semantic newlines, and see if you come up with 
something nicer.

man-pages(7):
    Use semantic newlines
        In  the  source of a manual page, new sentences should be
        started on new lines, long sentences should be split into
        lines at clause breaks (commas, semicolons,  colons,  and
        so on), and long clauses should be split at phrase bound‐
        aries.   This  convention,  sometimes  known as "semantic
        newlines", makes it easier to see the effect of  patches,
        which often operate at the level of individual sentences,
        clauses, or phrases.

<https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/commit/?id=6ff6f43d68164f99a8c3fb66f4525d145571310c>

Cheers,

Alex

>   .SH BUGS
>   .\" This function was broken in Linux libraries up to and including libc 5.0.9;
>   .\" there the

-- 
<http://www.alejandro-colomar.es/>

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]