admin/git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'jc/doc-release-vs-clear'

Browse Source 
Doc update.

* jc/doc-release-vs-clear:
  CodingGuidelines: clarify that S_release() does not reinitialize
This commit is contained in:
Junio C Hamano
2025-08-04 08:10:35 -07:00
parent d8f795e08a 4ac3302a1a
commit 67424f5bca
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/CodingGuidelines
View File

@@ -624,8 +624,9 @@ For C programs:
- `S_init()` initializes a structure without allocating the - `S_init()` initializes a structure without allocating the
structure itself. structure itself.
- `S_release()` releases a structure's contents without freeing the - `S_release()` releases a structure's contents without reinitializing
structure. the structure for immediate reuse, and without freeing the structure
itself.
- `S_clear()` is equivalent to `S_release()` followed by `S_init()` - `S_clear()` is equivalent to `S_release()` followed by `S_init()`
such that the structure is directly usable after clearing it. When such that the structure is directly usable after clearing it. When