Page MenuHomeFreeBSD
Differential D35518

man tree: add RB_AUGMENT description
ClosedPublic
Actions

Authored by dougm on Jun 19 2022, 2:40 AM.
Tags
None
Referenced Files
F107556296: D35518.diff
Wed, Jan 15, 9:02 PM
Unknown Object (File)
Oct 26 2024, 3:31 PM
Unknown Object (File)
Oct 26 2024, 3:31 PM
Unknown Object (File)
Oct 26 2024, 3:31 PM
Unknown Object (File)
Oct 26 2024, 3:31 PM
Unknown Object (File)
Oct 26 2024, 3:31 PM
Unknown Object (File)
Oct 26 2024, 3:31 PM
Unknown Object (File)
Oct 26 2024, 3:11 PM
View All 80 Files
Subscribers
imp

Details

Reviewers
alc
kib
markj
Commits
rG689d65d736bb: tree.3: document RB_AUGMENT
rGa8380d272ae7: tree.3: document RB_AUGMENT
Summary

The RB_AUGMENT macro is not documented. Perhaps that is why it is rarely used. Attempt to document it.

Diff Detail

Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

dougm requested review of this revision.Jun 19 2022, 2:40 AM
dougm created this revision.
alc added inline comments.Jun 19 2022, 4:57 AM
share/man/man3/tree.3
594

I think that you should explicitly say that it is defined by the RB user.

dougm updated this revision to Diff 107148.Jun 19 2022, 5:03 AM

Tweak text, as directed.

dougm updated this revision to Diff 107150.Jun 19 2022, 5:47 AM

Add augmentation to the RB tree example.

dougm added reviewers: kib, markj.Jun 19 2022, 5:47 AM
kib added a comment.Jun 19 2022, 9:15 AM

You also should add a symlink to RB_AUGMENT.3 into share/man/man3/Makefile. Search for tree.3 there to see how it is done.

dougm updated this revision to Diff 107154.Jun 19 2022, 9:23 AM

Add a symlink.

kib accepted this revision.Jun 19 2022, 9:26 AM
This revision is now accepted and ready to land.Jun 19 2022, 9:26 AM
alc accepted this revision.Jun 19 2022, 4:51 PM
Closed by commit rGa8380d272ae7: tree.3: document RB_AUGMENT (authored by dougm). · Explain WhyJun 19 2022, 4:58 PM
This revision was automatically updated to reflect the committed changes.
dougm added a commit: rGa8380d272ae7: tree.3: document RB_AUGMENT.
Herald added a subscriber: imp. · View Herald TranscriptJun 19 2022, 4:58 PM
dougm added a commit: rG689d65d736bb: tree.3: document RB_AUGMENT.Jul 10 2022, 3:59 AM

Revision Contents
Changeset List

PathSize
share/
man/
man3/
19 lines

Diff 107143

View Options

share/man/man3/tree.3

Loading...