Page MenuHomeFreeBSD
Differential D51175

pathconf.2: Document the _PC_HAS_HIDDENSYSTEM name
ClosedPublic
Actions

Authored by rmacklem on Sat, Jul 5, 11:47 PM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Jul 11, 11:16 AM
Unknown Object (File)
Fri, Jul 11, 10:46 AM
Unknown Object (File)
Fri, Jul 11, 4:32 AM
Unknown Object (File)
Thu, Jul 10, 1:50 AM
Unknown Object (File)
Sun, Jul 6, 7:26 PM
Subscribers
imp
pauamma_gundo.com
ziaee

Details

Reviewers
kib
ziaee
Group Reviewers
manpages
Commits
rGac64cd191c3f: pathconf.2: Document the _PC_HAS_HIDDENSYSTEM name
Summary

Commit afd5bc630930 added a new pathconf name
_PC_HAS_HIDDENSYSTEM.

This patch documents this new name.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

rmacklem created this revision.Sat, Jul 5, 11:47 PM
Herald added subscribers: ziaee, imp. · View Herald TranscriptSat, Jul 5, 11:47 PM
rmacklem requested review of this revision.Sat, Jul 5, 11:47 PM
pauamma_gundo.com added a subscriber: pauamma_gundo.com.Sun, Jul 6, 12:06 AM
pauamma_gundo.com added inline comments.
lib/libsys/pathconf.2
183

Audience check: will intended readers understand that "UF_HIDDEN and UF_SYSTEM va_flags" refer to flags settable through chflags(2)?

rmacklem updated this revision to Diff 158036.Sun, Jul 6, 1:38 AM

Reword the description to reference chflags(2)
as suggested by Pau Amma.

ziaee accepted this revision as: ziaee.Sun, Jul 6, 1:46 AM

chflags(3) calls these Dv's, we could call them Dv's to bring them into the apropos results, or maybe something else if it makes more sense.

This revision is now accepted and ready to land.Sun, Jul 6, 1:46 AM
kib added inline comments.Sun, Jul 6, 11:12 AM
lib/libsys/pathconf.2
183

va_flags is the kernel-side struct va_attr member, this documentation is for users.

rmacklem updated this revision to Diff 158049.Sun, Jul 6, 2:48 PM

Put .Dv before UF_HIDDEN and UF_SYSTEM as suggested
by ziaee@ and replaced va_flags with flags as suggested
by kib@. (I did not put .Ar in front of flags, since it is not
an argument to pathconf. Should I?)

This revision now requires review to proceed.Sun, Jul 6, 2:48 PM
kib added a comment.Sun, Jul 6, 3:11 PM
In D51175#1168258, @rmacklem wrote:

Put .Dv before UF_HIDDEN and UF_SYSTEM as suggested
by ziaee@ and replaced va_flags with flags as suggested
by kib@. (I did not put .Ar in front of flags, since it is not
an argument to pathconf. Should I?)

IMO 'flags' there refers to the attribute of the file, so the .Ar markup is definitely not appropriate.

kib accepted this revision.Sun, Jul 6, 3:11 PM
This revision is now accepted and ready to land.Sun, Jul 6, 3:11 PM
ziaee accepted this revision.Sun, Jul 6, 6:06 PM

Agree with kib

ziaee added a comment.Sun, Jul 6, 6:28 PM

My litmus test for "should we mark it up" is "should users be able to find this page with apropos Ar=flags.

Closed by commit rGac64cd191c3f: pathconf.2: Document the _PC_HAS_HIDDENSYSTEM name (authored by rmacklem). · Explain WhySun, Jul 6, 7:26 PM
This revision was automatically updated to reflect the committed changes.
rmacklem added a commit: rGac64cd191c3f: pathconf.2: Document the _PC_HAS_HIDDENSYSTEM name.

Revision Contents
Changeset List

PathSize
lib/
libsys/
pathconf.2
pathconf.2.orig
7 lines

Diff 158036

View Options

lib/libsys/pathconf.2

Loading...