linprocfs.4: Improve docs around pid/self entries
ClosedPublic
Actions

Authored by michaelo on Wed, Dec 24, 6:14 PM.

Details

Reviewers

Commits

rGad6381a6ebf4: linprocfs.4: Improve docs around pid/self entries
rG0d31189cbce4: linprocfs.4: Improve docs around pid/self entries

Summary

Mark <pid> as a placeholder and document that self is a symlink to a directory.

PR: 283080
MFC after: 3 days

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 69464
Build 66347: arc lint + arc unit

Event Timeline

michaelo created this revision.Wed, Dec 24, 6:14 PM

Herald added a subscriber: imp. · View Herald TranscriptWed, Dec 24, 6:14 PM

michaelo requested review of this revision.Wed, Dec 24, 6:14 PM

Harbormaster completed remote builds in B69463: Diff 168572.Wed, Dec 24, 6:14 PM

ziaee added inline comments.Wed, Dec 24, 6:25 PM

share/man/man4/linprocfs.4
131	We call pid a path on this line.

michaelo added inline comments.Wed, Dec 24, 6:29 PM

share/man/man4/linprocfs.4
131	I do not follow. Can you please rephrase? Are you saying that `.Pa pid` as it is right now is sufficient?

ziaee added inline comments.Wed, Dec 24, 7:28 PM

share/man/man4/linprocfs.4
131	I think they should be the same since they're referring to the same instance of pid. Probably both Ar.

Address comments

Harbormaster completed remote builds in B69464: Diff 168575.Wed, Dec 24, 8:02 PM

Issue addressed.

@ziaee , is this accetable now?

If it renders correctly in man(1), then it's fine by me (away from desk atm).

Angle quotes are kinda funny in roff, I don't remember where they don't work, but they don't always work.

This revision is now accepted and ready to land.Fri, Dec 26, 6:16 PM

In D54358#1242602, @ziaee wrote:

If it renders correctly in man(1), then it's fine by me (away from desk atm).

Angle quotes are kinda funny in roff, I don't remember where they don't work, but they don't always work.

I took the idea from rc.conf(5). There, angle quotes are used as well. Wanted to stick for consistency.

In D54358#1242602, @ziaee wrote:

If it renders correctly in man(1), then it's fine by me (away from desk atm).

Angle quotes are kinda funny in roff, I don't remember where they don't work, but they don't always work.

Just checked. It works as long as your font has the glyph.

Perfect. Thanks for doing this and double checking!

Closed by commit rG0d31189cbce4: linprocfs.4: Improve docs around pid/self entries (authored by michaelo). · Explain WhyFri, Dec 26, 6:55 PM

This revision was automatically updated to reflect the committed changes.

michaelo added a commit: rG0d31189cbce4: linprocfs.4: Improve docs around pid/self entries.

michaelo added a commit: rGad6381a6ebf4: linprocfs.4: Improve docs around pid/self entries.Mon, Dec 29, 6:36 PM