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 2/3] Documentation: document naming schema for struct-related functions
Date: Wed, 24 Jul 2024 09:56:02 -0700 [thread overview]
Message-ID: <xmqq8qxqwwyl.fsf@gitster.g> (raw)
In-Reply-To: <xmqqikwuwx7j.fsf@gitster.g> (Junio C. Hamano's message of "Wed, 24 Jul 2024 09:50:40 -0700")
Junio C Hamano <gitster@pobox.com> writes:
> Patrick Steinhardt <ps@pks.im> writes:
>
>> + - Functions that operate on a specific structure and which are used by
>> + other subsystems shall be named after the structure.
> ...
>> + The function
>> + name should start with the name of the structure followed by a verb.
>> + E.g.
>> +
>> + struct strbuf;
>> +
>> + void strbuf_add(struct strbuf *buf, ...);
>> + ...
>> + void strbuf_reset(struct strbuf *buf);
Another thing we may want to say about these "The primary data
structure subsystem 'S' deals with is called 'struct S' and the
functions that operate on 'struct S' are named S_<verb>()" theme is
that the convention for S_<verb>() functions is to have the operand,
which is always 'struct S *', of the verb as the first parameter.
next prev parent reply other threads:[~2024-07-24 16:56 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 [this message]
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
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=xmqq8qxqwwyl.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=karthik.188@gmail.com \
--cc=ps@pks.im \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
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;
as well as URLs for NNTP newsgroup(s).