rbtree: add comment to rb_insert_augmented()
The comment is copied from Documentation/rbtree.txt, but this comment is so important that it should also be in the code. Signed-off-by: Lai Jiangshan <laijs@cn.fujitsu.com> Acked-by: Michel Lespinasse <walken@google.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
parent
f8da964dfb
commit
a841b65921
|
@ -43,6 +43,16 @@ struct rb_augment_callbacks {
|
||||||
|
|
||||||
extern void __rb_insert_augmented(struct rb_node *node, struct rb_root *root,
|
extern void __rb_insert_augmented(struct rb_node *node, struct rb_root *root,
|
||||||
void (*augment_rotate)(struct rb_node *old, struct rb_node *new));
|
void (*augment_rotate)(struct rb_node *old, struct rb_node *new));
|
||||||
|
/*
|
||||||
|
* Fixup the rbtree and update the augmented information when rebalancing.
|
||||||
|
*
|
||||||
|
* On insertion, the user must update the augmented information on the path
|
||||||
|
* leading to the inserted node, then call rb_link_node() as usual and
|
||||||
|
* rb_augment_inserted() instead of the usual rb_insert_color() call.
|
||||||
|
* If rb_augment_inserted() rebalances the rbtree, it will callback into
|
||||||
|
* a user provided function to update the augmented information on the
|
||||||
|
* affected subtrees.
|
||||||
|
*/
|
||||||
static inline void
|
static inline void
|
||||||
rb_insert_augmented(struct rb_node *node, struct rb_root *root,
|
rb_insert_augmented(struct rb_node *node, struct rb_root *root,
|
||||||
const struct rb_augment_callbacks *augment)
|
const struct rb_augment_callbacks *augment)
|
||||||
|
|
Loading…
Reference in a new issue