Page MenuHomeFreeBSD
Differential D57128

nlist.3: Move deprecation notice to its section
ClosedPublic
Actions

Authored by ziaee on Wed, May 20, 1:31 PM.

Details

Reviewers
emaste
Commits
rGc796cc5afff2: nlist.3: Move deprecation notice after intro
Summary

Its more clear and good practice for the first sentence of a description
to describe what something is, because there are a lot of different use
cases for documentation.

Fixes: 94b7a335683abcbcd76e8b67d37e21271d81590c

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ziaee created this revision.Wed, May 20, 1:31 PM
Herald added a subscriber: imp. · View Herald TranscriptWed, May 20, 1:31 PM
ziaee requested review of this revision.Wed, May 20, 1:31 PM
Harbormaster completed remote builds in B73283: Diff 178201.Wed, May 20, 1:31 PM
emaste added a comment.Wed, May 20, 2:28 PM

It's not really a deprecation notice though, and we will presumably never remove this function. If you'd rather have it at the end of the description that's fine with me.

ziaee updated this revision to Diff 178210.Wed, May 20, 3:00 PM

Thanks @emaste! What about this?

Harbormaster completed remote builds in B73285: Diff 178210.Wed, May 20, 3:00 PM
emaste accepted this revision.Wed, May 20, 3:02 PM
This revision is now accepted and ready to land.Wed, May 20, 3:02 PM
Closed by commit rGc796cc5afff2: nlist.3: Move deprecation notice after intro (authored by ziaee). · Explain WhyWed, May 20, 3:09 PM
This revision was automatically updated to reflect the committed changes.
ziaee added a commit: rGc796cc5afff2: nlist.3: Move deprecation notice after intro.

Revision Contents
Changeset List

PathSize
lib/
libc/
gen/
9 lines

Diff 178211

View Options

lib/libc/gen/nlist.3

Loading...