CodingGuidelines: clarify that S_release() does not reinitialize
In the section for naming various API functions, the fact that S_release() only releases the resources without preparing the structure for immediate reuse becomes only apparent when you readentries for S_release() and S_clear(). Clarify the description of S_release() a bit to make the entry self sufficient. Signed-off-by: Junio C Hamano <gitster@pobox.com>maint
parent
777489f9e0
commit
4ac3302a1a
|
@ -610,8 +610,9 @@ For C programs:
|
|||
- `S_init()` initializes a structure without allocating the
|
||||
structure itself.
|
||||
|
||||
- `S_release()` releases a structure's contents without freeing the
|
||||
structure.
|
||||
- `S_release()` releases a structure's contents without reinitializing
|
||||
the structure for immediate reuse, and without freeing the structure
|
||||
itself.
|
||||
|
||||
- `S_clear()` is equivalent to `S_release()` followed by `S_init()`
|
||||
such that the structure is directly usable after clearing it. When
|
||||
|
|
Loading…
Reference in New Issue