From: Junio C Hamano <gitster@pobox•com>
To: Patrick Steinhardt <ps@pks•im>
Cc: git@vger•kernel.org, Karthik Nayak <karthik.188@gmail•com>
Subject: Re: [PATCH 3/3] Documentation: document difference between release and free
Date: Wed, 24 Jul 2024 09:52:20 -0700 [thread overview]
Message-ID: <xmqqed7iwx4r.fsf@gitster.g> (raw)
In-Reply-To: <5e1de3c3159968e897a83c05dae5e8504d37a16c.1721818488.git.ps@pks.im> (Patrick Steinhardt's message of "Wed, 24 Jul 2024 13:05:22 +0200")
Patrick Steinhardt <ps@pks•im> writes:
> We semi-regularly have discussions around whether a function shall be
> named `release()` or `free()`. For most of the part we use these two
> terminologies quite consistently though:
>
> - `release()` only frees internal state of a structure, whereas the
> structure itself is not free'd.
>
> - `free()` frees both internal state and the structure itself.
>
> Carve out a space where we can add idiomatic names for common functions
> in our coding guidelines. This space can get extended in the future when
> we feel the need to document more idiomatic names.
We have _clear() in some subsystem/API. Are we sure the listed two
are sufficient and _clear() can be replaced with one of them
(perhaps _release())?
> Signed-off-by: Patrick Steinhardt <ps@pks•im>
> ---
> Documentation/CodingGuidelines | 12 ++++++++++++
> 1 file changed, 12 insertions(+)
>
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index 34fcbcb5a4..ace4c4ad0c 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -560,6 +560,18 @@ For C programs:
>
> void reset_strbuf(struct strbuf *buf);
>
> + - There are several common idiomatic names for functions performing
> + specific tasks on structures:
> +
> + - `<struct>_init()` initializes a structure without allocating the
> + structure itself.
> +
> + - `<struct>_release()` releases a structure's contents without
> + freeing the structure.
> +
> + - `<struct>_free()` releases a structure's contents and frees the
> + structure.
> +
> For Perl programs:
>
> - Most of the C guidelines above apply.
next prev parent reply other threads:[~2024-07-24 16:52 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-24 11:05 [PATCH 0/3] Documentation: some coding guideline updates Patrick Steinhardt
2024-07-24 11:05 ` [PATCH 1/3] Documentation: clarify indentation style for C preprocessor directives Patrick Steinhardt
2024-07-24 16:41 ` Junio C Hamano
2024-07-25 5:06 ` Junio C Hamano
2024-07-30 6:32 ` Patrick Steinhardt
2024-07-24 11:05 ` [PATCH 2/3] Documentation: document naming schema for struct-related functions Patrick Steinhardt
2024-07-24 11:42 ` Karthik Nayak
2024-07-24 13:12 ` Patrick Steinhardt
2024-07-24 16:50 ` Junio C Hamano
2024-07-24 16:56 ` Junio C Hamano
2024-07-30 6:41 ` Patrick Steinhardt
2024-07-24 11:05 ` [PATCH 3/3] Documentation: document difference between release and free Patrick Steinhardt
2024-07-24 11:46 ` Karthik Nayak
2024-07-24 13:11 ` Patrick Steinhardt
2024-07-24 14:30 ` Phillip Wood
2024-07-24 18:02 ` Junio C Hamano
2024-07-30 6:49 ` Patrick Steinhardt
2024-07-24 16:52 ` Junio C Hamano [this message]
2024-07-30 6:43 ` Patrick Steinhardt
2024-07-24 11:47 ` [PATCH 0/3] Documentation: some coding guideline updates Karthik Nayak
2024-07-30 7:24 ` [PATCH v2 0/5] " Patrick Steinhardt
2024-07-30 7:24 ` [PATCH v2 1/5] clang-format: fix indentation width for preprocessor directives Patrick Steinhardt
2024-07-30 14:19 ` Karthik Nayak
2024-07-30 7:24 ` [PATCH v2 2/5] Documentation: clarify indentation style for C " Patrick Steinhardt
2024-07-30 7:24 ` [PATCH v2 3/5] Documentation: document naming schema for structs and their functions Patrick Steinhardt
2024-07-30 7:24 ` [PATCH v2 4/5] Documentation: document idiomatic function names Patrick Steinhardt
2024-07-30 7:24 ` [PATCH v2 5/5] Documentation: consistently use spaces inside initializers Patrick Steinhardt
2024-07-30 20:55 ` [PATCH v2 0/5] Documentation: some coding guideline updates Junio C Hamano
2024-07-31 9:12 ` Karthik Nayak
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqed7iwx4r.fsf@gitster.g \
--to=gitster@pobox$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=karthik.188@gmail$(echo .)com \
--cc=ps@pks$(echo .)im \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox