Page MenuHomeFreeBSD
Differential D25892

directory(3): Add an ERRORS section
ClosedPublic
Actions

Authored by gbe on Jul 30 2020, 9:22 AM.
Tags
None
Referenced Files
Unknown Object (File)
Dec 5 2024, 4:44 PM
Unknown Object (File)
Oct 3 2024, 5:02 PM
Unknown Object (File)
Sep 19 2024, 12:24 PM
Unknown Object (File)
Sep 8 2024, 9:40 PM
Unknown Object (File)
Sep 5 2024, 7:47 PM
Unknown Object (File)
Sep 4 2024, 6:29 PM
Unknown Object (File)
Sep 2 2024, 2:49 PM
Unknown Object (File)
Sep 1 2024, 4:30 PM
View All 36 Files
Subscribers
0mp
bcr
imp
jilles

Details

Reviewers
0mp
jilles
Group Reviewers
manpages
Commits
rS364106: MFC r363829: directory(3): Add an ERRORS section
rS363829: directory(3): Add an ERRORS section
Summary

directory(3): Add an ERRORS section

  • Add an ERRORS section for opendir(3)
  • Document readdir(), readdir_r(), telldir() and closedir()
  • Convert the code sample into an EXAMPLES section

PR: 75711
Obtained from: partial from OpenBSD

Test Plan

mandoc output review and 'mandoc -Tlint' checks

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

gbe requested review of this revision.Jul 30 2020, 9:22 AM
gbe created this revision.
Harbormaster completed remote builds in B32658: Diff 75159.Jul 30 2020, 9:22 AM
bcr accepted this revision as: manpages.Jul 30 2020, 9:33 AM
bcr added a subscriber: bcr.

Looks good to me. Thanks for the update, Gordon.

jilles added a subscriber: jilles.Jul 30 2020, 7:25 PM
jilles added inline comments.
lib/libc/gen/directory.3
266 ↗(On Diff #75159)

The error is named slightly differently.

0mp accepted this revision.Jul 31 2020, 8:55 AM
0mp added a subscriber: 0mp.

Just a couple of minor comments.

lib/libc/gen/directory.3
265 ↗(On Diff #75159)

"Er" does not expand to anything interesting as an argument to -width, so it would be better to either change it to something more idiomatic like 2n if you need two spaces of width.

298 ↗(On Diff #75159)

Same as above :)

This revision is now accepted and ready to land.Jul 31 2020, 8:55 AM
gbe updated this revision to Diff 75239.Aug 1 2020, 8:06 AM
  • Correct the error EACCES
This revision now requires review to proceed.Aug 1 2020, 8:06 AM
Harbormaster completed remote builds in B32688: Diff 75239.Aug 1 2020, 8:06 AM
gbe marked an inline comment as done.Aug 1 2020, 8:08 AM
gbe added inline comments.
lib/libc/gen/directory.3
265 ↗(On Diff #75159)

I had a quick look in a few other man pages and the "-width Er" seems to be standard for error section. I would leave it that way.

266 ↗(On Diff #75159)

Thanks, I have corrected it.

jilles accepted this revision as: jilles.Aug 1 2020, 7:58 PM
This revision is now accepted and ready to land.Aug 1 2020, 7:58 PM
0mp added inline comments.Aug 2 2020, 3:28 PM
lib/libc/gen/directory.3
265 ↗(On Diff #75159)

Alright, thanks for checking :)

Closed by commit rS363829: directory(3): Add an ERRORS section (authored by gbe). · Explain WhyAug 4 2020, 8:46 AM
This revision was automatically updated to reflect the committed changes.
gbe marked an inline comment as done.
gbe added a commit: rS363829: directory(3): Add an ERRORS section.
Herald added a subscriber: imp. · View Herald TranscriptAug 4 2020, 8:46 AM
gbe added a commit: rS364106: MFC r363829: directory(3): Add an ERRORS section.Aug 11 2020, 10:57 AM

Revision Contents
Changeset List

PathSize
head/
lib/
libc/
gen/
74 lines

Diff 75344

View Options

head/lib/libc/gen/directory.3

Loading...