diff options
author | Patrick Steinhardt <ps@pks.im> | 2024-07-30 09:24:47 +0200 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2024-07-30 13:50:25 -0700 |
commit | 10f0723c8df41c9c2a4dec7e3571e98ec57138f1 (patch) | |
tree | 9f804796879b1778ed40c642452d1c349f0ef8a0 /builtin/commit.c | |
parent | 541204aabea80ce466b5f62bf6613cdaf104dd5a (diff) |
Documentation: document idiomatic function names
We semi-regularly have discussions around whether a function shall be
named `S_release()`, `S_clear()` or `S_free()`. Indeed, it may not be
obvious which of these is preferable as we never really defined what
each of these variants means exactly.
Carve out a space where we can add idiomatic names for common functions
in our coding guidelines and define each of those functions. Like this,
we can get to a shared understanding of their respective semantics and
can easily point towards our style guide in future discussions such that
our codebase becomes more consistent over time.
Note that the intent is not to rename all functions which violate these
semantics right away. Rather, the intent is to slowly converge towards a
common style over time.
Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'builtin/commit.c')
0 files changed, 0 insertions, 0 deletions