Page MenuHomeFreeBSD
Differential D10852

Document st_flags in the stat(2).
ClosedPublic
Actions

Authored by sobomax on May 22 2017, 5:02 AM.
Tags
None
Referenced Files
Unknown Object (File)
Dec 20 2023, 3:18 AM
Unknown Object (File)
Sep 25 2023, 3:27 AM
Unknown Object (File)
Jun 11 2023, 9:10 PM
Unknown Object (File)
May 20 2023, 11:13 PM
Unknown Object (File)
Dec 20 2022, 2:51 PM
Subscribers
imp
jilles
vangyzen

Details

Reviewers
mckusick
vangyzen
jilles
Group Reviewers
manpages
Commits
rS320004: Document st_flags in the stat(2).
Summary

The st_flags is quite important bit of info returned by the stat and used a lot around the code, yet not mentioned in the man page. Fill in the void by xref-ing chflags manpage.

Diff Detail

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

Event Timeline

sobomax created this revision.May 22 2017, 5:02 AM
Herald added a subscriber: imp. · View Herald TranscriptMay 22 2017, 5:02 AM
vangyzen accepted this revision.May 22 2017, 12:34 PM
vangyzen added a subscriber: vangyzen.
vangyzen added inline comments.
lib/libc/sys/stat.2
31 ↗(On Diff #28651)

Remember to bump this when you commit.

141 ↗(On Diff #28651)

"User-defined" should be hyphenated.

Add "the" before "file".

This revision is now accepted and ready to land.May 22 2017, 12:34 PM
jilles added a subscriber: jilles.May 22 2017, 9:34 PM
jilles added inline comments.
lib/libc/sys/stat.2
141 ↗(On Diff #28651)

I think "user-defined" should be removed entirely, since file flags are no more user-defined than permission bits are.

vangyzen added inline comments.May 22 2017, 9:45 PM
lib/libc/sys/stat.2
141 ↗(On Diff #28651)

Good point. Agreed.

Maybe the original author meant "user-assigned", but even that seems too verbose.

mckusick requested changes to this revision.May 22 2017, 9:48 PM
mckusick added inline comments.
lib/libc/sys/stat.2
141 ↗(On Diff #28651)

I concur with jilles. I would word it as "The file's flags." or perhaps "The flags enabled for the file.''

This revision now requires changes to proceed.May 22 2017, 9:48 PM
mckusick accepted this revision.May 22 2017, 10:05 PM

With suggested change, I am happy with this (useful) update.

This revision is now accepted and ready to land.May 22 2017, 10:05 PM
sobomax updated this revision to Diff 28698.May 23 2017, 1:47 AM
sobomax edited edge metadata.

Re-phrase a bit based on suggestions.

This revision now requires review to proceed.May 23 2017, 1:47 AM
sobomax marked an inline comment as done.May 23 2017, 2:05 AM

Adjusted a bit as suggested.

vangyzen accepted this revision.May 23 2017, 12:52 PM
This revision is now accepted and ready to land.May 23 2017, 12:52 PM
mckusick accepted this revision.May 23 2017, 7:22 PM

Looks good. Make it so.

jilles accepted this revision.May 23 2017, 8:16 PM
Closed by commit rS320004: Document st_flags in the stat(2). (authored by sobomax). · Explain WhyJun 16 2017, 3:10 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
head/
lib/
libc/
sys/
5 lines

Diff 29721

View Options

head/lib/libc/sys/stat.2

Loading...