access.2: Mention that lstat(2) should be used for symbolic links
ClosedPublic
Actions

Authored by gbe on Apr 21 2024, 9:56 AM.

Details

Reviewers

imp
emaste
pauamma_gundo.com

Group Reviewers

manpages

Commits

rG8766ae10d3b7: access.2: Mention that lstat(2) should be used for symbolic links
rG78ea1fcf29a7: access.2: Mention that lstat(2) should be used for symbolic links
rGf075b6113726: access.2: Mention that lstat(2) should be used for symbolic links
rG421025a274fb: access.2: Mention that lstat(2) should be used for symbolic links

Summary

access(), eaccess() and faccessat() will always dereference
symbolic links.

So add a note the manual page, that stat(2) should be used in
the case of symbolic links.

PR: 262895
MFC after: 1 week

Test Plan

mandoc output review and 'mandoc -Tlint' checks

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 57299
Build 54187: arc lint + arc unit

Event Timeline

gbe requested review of this revision.Apr 21 2024, 9:56 AM

gbe created this revision.

Harbormaster completed remote builds in B57255: Diff 137456.Apr 21 2024, 9:56 AM

There are 2 spurious ) after eaccess and faccessat in the change summary.

This revision is now accepted and ready to land.Apr 21 2024, 12:23 PM

In D44890#1023405, @pauamma_gundo.com wrote:

There are 2 spurious ) after eaccess and faccessat in the change summary.

Thanks, when typing fast, auto completion can be evil. ;)

I realise that it's my fault for using the weak word "refer" in my original suggestion (I originally wrote "access, eaccess, faccessat will ALWAYS dereference symbolic links. If you need to refer to the symbolic link itself, you'll have to instead use stat(2)") but I think it looks even less suitable in your submission. Would "If the symbolic link itself needs to be referenced..." be better?

Cheers, Jamie

Oops. Suggested alternative should be "lstat(2)" not "stat(2)" !

Reword a sentence and recommand lstat(2) instead of stat(2)

This revision now requires review to proceed.Apr 23 2024, 2:42 PM

Harbormaster completed remote builds in B57299: Diff 137550.Apr 23 2024, 2:42 PM

gbe retitled this revision from access.2: Mention that stat(2) should be used for symbolic links to access.2: Mention that lstat(2) should be used for symbolic links.Apr 23 2024, 2:43 PM

English and markup still LGTM.

This revision is now accepted and ready to land.Apr 24 2024, 1:16 AM

Closed by commit rG421025a274fb: access.2: Mention that lstat(2) should be used for symbolic links (authored by gbe). · Explain WhyMay 13 2024, 8:41 AM

This revision was automatically updated to reflect the committed changes.

gbe added a commit: rG421025a274fb: access.2: Mention that lstat(2) should be used for symbolic links.

des added a commit: rGf075b6113726: access.2: Mention that lstat(2) should be used for symbolic links.May 23 2024, 2:42 AM

des added a commit: rG78ea1fcf29a7: access.2: Mention that lstat(2) should be used for symbolic links.May 23 2024, 2:44 AM

des added a commit: rG8766ae10d3b7: access.2: Mention that lstat(2) should be used for symbolic links.May 23 2024, 2:48 AM