Page MenuHomeFreeBSD
Differential D52925

fts: Further improve the manual page
ClosedPublic
Actions

Authored by des on Mon, Oct 6, 9:25 AM.
Tags
None
Referenced Files
F134076727: D52925.diff
Thu, Oct 30, 2:11 PM
Unknown Object (File)
Wed, Oct 29, 9:47 AM
Unknown Object (File)
Wed, Oct 29, 8:28 AM
Unknown Object (File)
Sun, Oct 26, 2:23 PM
Unknown Object (File)
Sun, Oct 26, 2:23 PM
Unknown Object (File)
Sun, Oct 26, 2:22 PM
Unknown Object (File)
Sun, Oct 26, 2:19 PM
Unknown Object (File)
Fri, Oct 24, 11:58 PM
View All 26 Files
Subscribers
bcr
imp
markj
ziaee

Details

Reviewers
bcr
markj
Group Reviewers
Klara
manpages
Commits
rGa802334d86c7: fts: Further improve the manual page
Summary
  • Add subsections for the three functions that didn't already have one.
  • Add a RETURN VALUES section.
  • Improve the grammar somewhat.
  • Clarify that fts_read() will not set errno to 0 if called again after having already returned NULL.

Sponsored by: Klara, Inc.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

des created this revision.Mon, Oct 6, 9:25 AM
Herald added subscribers: ziaee, imp. · View Herald TranscriptMon, Oct 6, 9:25 AM
des requested review of this revision.Mon, Oct 6, 9:25 AM
Harbormaster completed remote builds in B67577: Diff 163617.Mon, Oct 6, 9:25 AM
des added a reviewer: manpages.Mon, Oct 6, 9:31 AM
bcr accepted this revision.Mon, Oct 6, 10:59 AM
bcr added a subscriber: bcr.

Looks good to me, thanks for the additions to the man page.

This revision is now accepted and ready to land.Mon, Oct 6, 10:59 AM
markj added a subscriber: markj.Mon, Oct 6, 12:16 PM
markj added inline comments.
lib/libc/gen/fts.3
549

Should this also be The .Fa compar argument points to...?

637

Reading the whole section, this detail is kind of confusing. What exactly is supposed to happen if you call fts_read() again after it returned NULL? For an end-of-stream condition I guess it'll just return NULL again, but what happens if an error "unrelated to a file in the hierarchy" occurs? It's not very clear to me what that means... is it referring to memory allocation failure?

866

The fts_read ssection distinguishes between different types of errors (related to a returned file vs. unrelated), whereas here we do not, so this seems inconsistent, or I am missing something.

des updated this revision to Diff 163683.Tue, Oct 7, 9:13 AM
des marked 3 inline comments as done.

rf

This revision now requires review to proceed.Tue, Oct 7, 9:13 AM
Harbormaster completed remote builds in B67603: Diff 163683.Tue, Oct 7, 9:13 AM
des added inline comments.Tue, Oct 7, 9:13 AM
lib/libc/gen/fts.3
637

Yes it's unclear and also incorrect, I misremembered.

markj accepted this revision as: markj.Tue, Oct 7, 1:52 PM
This revision is now accepted and ready to land.Tue, Oct 7, 1:52 PM
Closed by commit rGa802334d86c7: fts: Further improve the manual page (authored by des). · Explain WhyTue, Oct 7, 4:25 PM
This revision was automatically updated to reflect the committed changes.
des added a commit: rGa802334d86c7: fts: Further improve the manual page.
des mentioned this in rG8c9b3ad2ec2a: fts: Document thread (un)safety.Thu, Oct 9, 12:21 PM
des mentioned this in rGb2f1fa13e98f: fts: Document thread (un)safety.

Revision Contents
Changeset List

PathSize
lib/
libc/
gen/
146 lines

Diff 163704

View Options

lib/libc/gen/fts.3

Loading...