Skip to contentSkip to conversation

bcmp: note that this function is no longer legacy due to LLVM 9

PATCH In review Shawn Landden 3 participants 3 messages Jan 11, 2020 – Jan 21, 2020 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 bcmp: note that this function is no longer legacy due to LLVM 9

---
 man3/bcmp.3 | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)
man3/bcmp.3 +9 -3
index ba9838019..18d238720 100644
@@ -70,15 +70,21 @@ T{
 .BR bcmp ()
 T}	Thread safety	MT-Safe
 .TE
 .SH CONFORMING TO
 4.3BSD.
-This function is deprecated (marked as LEGACY in POSIX.1-2001): use
-.BR memcmp (3)
-in new programs.
+This function was deprecated (marked as LEGACY) by POSIX.1-2001).
 POSIX.1-2008 removes the specification of
 .BR bcmp ().
+LLVM 9, released in 2019, revived
+.BR bcmp ()
+and generates calls to it instead of
+.BR memcmp (3)
+as appropiate as an optimization (as
+.BR bcmp ()
+need not traverse memory in-order).
+.\" http://releases.llvm.org/9.0.0/docs/ReleaseNotes.html#noteworthy-optimizations
 .SH SEE ALSO
 .BR bstring (3),
 .BR memcmp (3),
 .BR strcasecmp (3),
 .BR strcmp (3),
Signature · 1 line
2.20.1
#1 lore raw

Hi,

Quoted 19 lines · Shawn Landden
---
 man3/bcmp.3 | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)
man3/bcmp.3 +1 -3
index ba9838019..18d238720 100644
@@ -70,15 +70,21 @@ T{
 .BR bcmp ()
 T}	Thread safety	MT-Safe
 .TE
 .SH CONFORMING TO
 4.3BSD.
-This function is deprecated (marked as LEGACY in POSIX.1-2001): use
-.BR memcmp (3)
-in new programs.
+This function was deprecated (marked as LEGACY) by POSIX.1-2001).

man3/bcmp.3 T{ · line 85

Quoted 10 lines
man3/bcmp.3 +8 -0
 POSIX.1-2008 removes the specification of
 .BR bcmp ().
+LLVM 9, released in 2019, revived
+.BR bcmp ()
+and generates calls to it instead of
+.BR memcmp (3)
+as appropiate as an optimization (as
+.BR bcmp ()
+need not traverse memory in-order).
+.\" http://releases.llvm.org/9.0.0/docs/ReleaseNotes.html#noteworthy-optimizations

I believe the "CONFORMING TO" is about conformance and therefore shall not be changed.

Any notes about llvm-specific implementation details should go to a different section, e.g. "NOTES".

Signature · 1 line
ldv
#2 lore raw

Shawn,

Quoted 36 lines · Dmitry V. Levin

Hi,

Quoted 19 lines · Shawn Landden
---
 man3/bcmp.3 | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)
man3/bcmp.3 +1 -3
index ba9838019..18d238720 100644
@@ -70,15 +70,21 @@ T{
 .BR bcmp ()
 T}	Thread safety	MT-Safe
 .TE
 .SH CONFORMING TO
 4.3BSD.
-This function is deprecated (marked as LEGACY in POSIX.1-2001): use
-.BR memcmp (3)
-in new programs.
+This function was deprecated (marked as LEGACY) by POSIX.1-2001).

man3/bcmp.3 T{ · line 85

Quoted 10 lines
man3/bcmp.3 +8 -0
 POSIX.1-2008 removes the specification of
 .BR bcmp ().
+LLVM 9, released in 2019, revived
+.BR bcmp ()
+and generates calls to it instead of
+.BR memcmp (3)
+as appropiate as an optimization (as
+.BR bcmp ()
+need not traverse memory in-order).
+.\" http://releases.llvm.org/9.0.0/docs/ReleaseNotes.html#noteworthy-optimizations

I believe the "CONFORMING TO" is about conformance and therefore shall not be changed.

Quoted 2 lines

Any notes about llvm-specific implementation details should go to a different section, e.g. "NOTES".

I'm not convinced that anything at all needs to be added to the manual page. This is an implement-specific detail about a certain compiler. Its behavior might change in the future. You do not say anything about why t is relevant to document this detail.

Thanks,

Michael

Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/