Page MenuHomeFreeBSD
Differential D53658

man/man3: add stdbit.3
AcceptedPublic
Actions

Authored by fuz on Mon, Nov 10, 9:32 AM.
Tags
None
Referenced Files
F136848091: D53658.id.diff
Thu, Nov 20, 1:50 AM
F136847945: D53658.id166240.diff
Thu, Nov 20, 1:49 AM
F136847919: D53658.id166112.diff
Thu, Nov 20, 1:48 AM
F136847908: D53658.id166128.diff
Thu, Nov 20, 1:48 AM
F136846761: D53658.diff
Thu, Nov 20, 1:35 AM
Unknown Object (File)
Wed, Nov 19, 5:49 AM
Unknown Object (File)
Tue, Nov 18, 9:31 AM
Unknown Object (File)
Sun, Nov 16, 5:55 PM
View All 25 Files
Subscribers
adrian
imp
kib
pauamma_gundo.com
ziaee

Details

Reviewers
markj
adrian
Group Reviewers
manpages
Summary

This is the overview man page for the <stdbit.h> functions.
Individual man pages will follow in a later DR.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 68542
Build 65425: arc lint + arc unit

Event Timeline

fuz created this revision.Mon, Nov 10, 9:32 AM
Herald added subscribers: ziaee, imp. · View Herald TranscriptMon, Nov 10, 9:32 AM
fuz requested review of this revision.Mon, Nov 10, 9:32 AM
Harbormaster completed remote builds in B68498: Diff 166112.Mon, Nov 10, 9:32 AM
fuz added a parent revision: D53657: libc: implement C23 <stdbit.h> functions.Mon, Nov 10, 9:35 AM
fuz added a child revision: D53659: libc/stdbit: add man pages for stdbit functions.
ziaee added a comment.Mon, Nov 10, 1:40 PM

This is awesome!

share/man/man3/stdbit.3
4

The license block has blank comments at the top and bottom (before 1 and after 3).

11

The .Sh LIBRARY section is deprecated, .Lb libc now goes at the top of .Sh SYNOPSIS

fuz updated this revision to Diff 166128.Mon, Nov 10, 2:12 PM
  • stdbit.3: address ziaee's review comments
Harbormaster completed remote builds in B68506: Diff 166128.Mon, Nov 10, 2:12 PM
fuz mentioned this in D53659: libc/stdbit: add man pages for stdbit functions.Mon, Nov 10, 2:22 PM
fuz updated this revision to Diff 166240.Tue, Nov 11, 3:50 PM
fuz marked 2 inline comments as done.
  • stdbit.3: remove - from \"-
Harbormaster completed remote builds in B68542: Diff 166240.Tue, Nov 11, 3:50 PM
pauamma_gundo.com added a subscriber: pauamma_gundo.com.Wed, Nov 12, 2:48 AM

English looks good to me. Can't speak to the rest.

kib added a subscriber: kib.Wed, Nov 12, 5:05 AM
kib added inline comments.
share/man/man3/stdbit.3
11

May be, 'Standard 2023 C bit and byte utilties'?

51
55
95

Why these (stdc_*) functions are listed in the 'SEE ALSO' section?
First, there is no separate man pages for each of them.
Second, isn't this man page is supposed to document them?

fuz added inline comments.Wed, Nov 12, 10:36 AM
share/man/man3/stdbit.3
11

I don't see why it's important to point out that this header was added in C23. It's not like we say that anywhere else.

55

I would prefer to leave the sentence in, as it clarifies the behaviour on platforms where there are indeed other byte orders.
The new sentence is useful, I'll add that in.

95

D53659 adds man pages for all these functions. There are 70 functions and 14 type-generic macros in total, so I thought it would be more useful to have an individual page for each.

kib added inline comments.Fri, Nov 14, 1:11 AM
share/man/man3/stdbit.3
11

To direct people to where look for further reference about the functions.

95

Ok.

ziaee added inline comments.Fri, Nov 14, 1:22 AM
share/man/man3/stdbit.3
11

We usually handle this with a STANDARDS section

fuz mentioned this in D53657: libc: implement C23 <stdbit.h> functions.Tue, Nov 18, 2:43 PM
adrian accepted this revision.Tue, Nov 18, 3:03 PM
adrian added a subscriber: adrian.

looks good, maybe get a review from @ziaee too for manpage stuff and then land?

This revision is now accepted and ready to land.Tue, Nov 18, 3:03 PM

Revision Contents
Changeset List

PathSize
share/
man/
man3/
1 line
120 lines

Diff 166240

View Options

share/man/man3/Makefile

Loading...
View Options

share/man/man3/stdbit.3

Loading...