Merge pull request #225 from SimonLiu423/docs/clarify-list-add

jserv · web-flow · commit 29d90eaefcef · 2025-03-05T11:13:28.000+08:00
Clarify list_add documentation
diff --git a/list.h b/list.h
@@ -90,13 +90,13 @@ static inline void INIT_LIST_HEAD(struct list_head *head)
 }
 
 /**
- * list_add - Insert a node at the beginning of a circular list
+ * list_add - Insert a node after a given node in a circular list
  * @node: Pointer to the list_head structure to add.
- * @head: Pointer to the list_head structure representing the list head.
+ * @head: Pointer to the list_head structure after which to add the new node.
  *
  * Adds the specified @node immediately after @head in a circular doubly-linked
- * list, effectively placing it at the beginning. The existing first node, if
- * any, shifts to follow @node, and the list's circular structure is maintained.
+ * list. The node that previously followed @head will now follow @node, and the
+ * list's circular structure is maintained.
  */
 static inline void list_add(struct list_head *node, struct list_head *head)
 {
diff --git a/scripts/checksums b/scripts/checksums
@@ -1,3 +1,3 @@
 398b59c23f699ff1bf1e73a94503a9a91caa9207  queue.h
-9be9666430f392924f5d27caa71a412527bf9267  list.h
+5179cf8f5aafbc6cb8e8d7b898ef3798cfe85613  list.h
 1029c2784b4cae3909190c64f53a06cba12ea38e  scripts/check-commitlog.sh

Original file line number	Diff line number	Diff line change
`@@ -90,13 +90,13 @@ static inline void INIT_LIST_HEAD(struct list_head *head)`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`/**`
`93`		`- * list_add - Insert a node at the beginning of a circular list`
	`93`	`+ * list_add - Insert a node after a given node in a circular list`
`94`	`94`	`* @node: Pointer to the list_head structure to add.`
`95`		`- * @head: Pointer to the list_head structure representing the list head.`
	`95`	`+ * @head: Pointer to the list_head structure after which to add the new node.`
`96`	`96`	`*`
`97`	`97`	`* Adds the specified @node immediately after @head in a circular doubly-linked`
`98`		`- * list, effectively placing it at the beginning. The existing first node, if`
`99`		`- * any, shifts to follow @node, and the list's circular structure is maintained.`
	`98`	`+ * list. The node that previously followed @head will now follow @node, and the`
	`99`	`+ * list's circular structure is maintained.`
`100`	`100`	`*/`
`101`	`101`	`static inline void list_add(struct list_head node, struct list_head head)`
`102`	`102`	`{`