Skip to content

Commit dd9490d

Browse files
committed
Merge branch 'jc/doc-release-vs-clear' into next
Doc update. * jc/doc-release-vs-clear: CodingGuidelines: clarify that S_release() does not reinitialize
2 parents 478a84a + 4ac3302 commit dd9490d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

Documentation/CodingGuidelines

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -624,8 +624,9 @@ For C programs:
624624
- `S_init()` initializes a structure without allocating the
625625
structure itself.
626626

627-
- `S_release()` releases a structure's contents without freeing the
628-
structure.
627+
- `S_release()` releases a structure's contents without reinitializing
628+
the structure for immediate reuse, and without freeing the structure
629+
itself.
629630

630631
- `S_clear()` is equivalent to `S_release()` followed by `S_init()`
631632
such that the structure is directly usable after clearing it. When

0 commit comments

Comments
 (0)