Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a841b659 authored by Lai Jiangshan's avatar Lai Jiangshan Committed by Linus Torvalds
Browse files

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: default avatarLai Jiangshan <laijs@cn.fujitsu.com>
Acked-by: default avatarMichel Lespinasse <walken@google.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent f8da964d

include/linux/rbtree_augmented.h

+10 −0
Original line number Diff line number Diff line
@@ -43,6 +43,16 @@ struct rb_augment_callbacks { 


extern void __rb_insert_augmented(struct rb_node *node, struct rb_root *root,

	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

rb_insert_augmented(struct rb_node *node, struct rb_root *root,

		    const struct rb_augment_callbacks *augment)