fts: Further improve the manual page
ClosedPublic
Actions

Authored by des on Mon, Oct 6, 9:25 AM.

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.

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 67603
Build 64486: arc lint + arc unit

des created this revision.Mon, Oct 6, 9:25 AM

des requested review of this revision.Mon, Oct 6, 9:25 AM

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 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.