Couple of small issues

Couple of small issues

[Jukka Ruohonen]

[-- Attachment #1: Type: text/plain, Size: 615 bytes --]

Hi.

Two small issues:

1. At least FreeBSD and NetBSD define ffs(3) in <strings.h>, as
   mandated/recommended by POSIX.

2. In endian(3) there are some historical notes that are incorrect or at
   least unclear.

I could probably go and audit rest of the manual pages that contains (often
outdated or plain wrong) references to the BSDs and other operating systems.

While reading the changelog, I noticed (an implicit?) trend towards trying
to limit the documentation to Linux only. I think this is a good idea;
surely there is enough work to keep the manual pages updated with respect to
Linux alone.

- Jukka.

[-- Attachment #2: ffs.diff --]
[-- Type: text/plain, Size: 611 bytes --]

diff --git a/man3/ffs.3 b/man3/ffs.3
index bc5c2ae..e62f6b2 100644
--- a/man3/ffs.3
+++ b/man3/ffs.3
@@ -28,7 +28,7 @@
 .\"
 .\" Modified 2003 Walter Harms (walter.harms-jNDFPZUTrfTUvfpBxBsQfasoZZ7OtMbqG9Ur7JDdleE@public.gmane.org)
 .\"
-.TH FFS 3 2009-08-27 "GNU" "Linux Programmer's Manual"
+.TH FFS 3 2010-07-02 "GNU" "Linux Programmer's Manual"
 .SH NAME
 ffs, ffsl, ffsll \- find first bit set in a word
 .SH SYNOPSIS
@@ -69,9 +69,6 @@ The
 and
 .BR ffsll ()
 are glibc extensions.
-.SH NOTES
-BSD systems have a prototype in
-.IR <string.h> .
 .SH "SEE ALSO"
 .BR memchr (3),
 .BR feature_test_macros (7)

[-- Attachment #3: endian.diff --]
[-- Type: text/plain, Size: 1004 bytes --]

diff --git a/man3/endian.3 b/man3/endian.3
index ee040ff..aea1521 100644
--- a/man3/endian.3
+++ b/man3/endian.3
@@ -23,7 +23,7 @@
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
 .\"
-.TH ENDIAN 3  2009-01-19 "GNU" "Linux Programmer's Manual"
+.TH ENDIAN 3  2010-07-02 "GNU" "Linux Programmer's Manual"
 .SH NAME
 htobe16, htole16, be16toh, le16toh, htobe32, htole32, be32toh, le32toh,
 htobe64, htole64, be64toh, le64toh \-
@@ -78,14 +78,6 @@ where the required header file is
 .I <sys/endian.h>
 instead of
 .IR <endian.h> .
-Unfortunately,
-NetBSD, FreeBSD, and glibc haven't followed the original
-OpenBSD naming convention for these functions,
-whereby the
-.I nn
-component always appears at the end of the function name
-(thus, for example, in NetBSD, FreeBSD, and glibc,
-the equivalent of OpenBSDs "betoh32" is "be32toh").
 .SH NOTES
 These functions are similar to the older
 .BR byteorder (3)

Re: Couple of small issues

[Michael Kerrisk]

Hello Jukka,

On Fri, Jul 2, 2010 at 11:46 AM, Jukka Ruohonen <jruohonen-X3B1VOXEql0@public.gmane.org> wrote:
> Hi.
>
> Two small issues:
>
> 1. At least FreeBSD and NetBSD define ffs(3) in <strings.h>, as
>   mandated/recommended by POSIX.

I'm not sure what you want to say here. Does something need fixing in
ffs(3)? It's not obvious to me.

> 2. In endian(3) there are some historical notes that are incorrect or at
>   least unclear.

Can you elaborate.

> I could probably go and audit rest of the manual pages that contains (often
> outdated or plain wrong) references to the BSDs and other operating systems.

That would be good.

> While reading the changelog, I noticed (an implicit?) trend towards trying
> to limit the documentation to Linux only. I think this is a good idea;
> surely there is enough work to keep the manual pages updated with respect to
> Linux alone.

I'm not sure if I know what the implicit rend is ;-). But, obviously,
the focus is Linux (with some attention to portability).

Thanks,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface"; http://man7.org/tlpi/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html