From: Junio C Hamano <gitster@pobox.com>
To: Stefan Beller <sbeller@google.com>
Cc: avarab@gmail.com, git@vger.kernel.org, jrnieder@gmail.com, peff@peff.net
Subject: Re: [PATCH] strbuf.h: format according to coding guidelines
Date: Fri, 28 Sep 2018 13:11:26 -0700 [thread overview]
Message-ID: <xmqqin2pbcwh.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <xmqqr2hdbdp8.fsf@gitster-ct.c.googlers.com> (Junio C. Hamano's message of "Fri, 28 Sep 2018 12:54:11 -0700")
Junio C Hamano <gitster@pobox.com> writes:
> Stefan Beller <sbeller@google.com> writes:
>
>> So let's format strbuf.h in a way that we'd like to see:
>> * omit the extern keyword from function declarations
>
> OK
>
>> * name all parameters (usually the parameters are obvious from its type,
>> but consider exceptions like
>> `int strbuf_getwholeline_fd(struct strbuf *, int, int);`
>
> I am mildly against giving names to obvious ones.
Just to make sure nobody listening from sidelines do not
misunderstand, ones like getwholeline_fd() that takes more than one
parameter with the same time is a prime example of a function that
take non-obvious parameters that MUST be named.
What I am mildly against is the rule that says "name ALL
parameters". I tend to think these names make headers harder to
read, and prefer to keep them to the minimum.
I actually do not mind the rule to be more like
* Use the same parameter names used in the function declaration when
the description in the API documentation refers the parameter.
That _forces_ people to write
/**
* Read a whole line up to the terminating character
* TERM (typically LF or NUL) from the file descriptor FD
* and replace the contents of the strbuf SB with the
* result ...
*/
int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term);
which is mostly equivalent to having a rule to always name all
parameters, while still allowing "sb" to be omitted by rephrasing
"the contents of the given strbuf with the result ..." and I
consider that a good flexibility to have.
next prev parent reply other threads:[~2018-09-28 20:11 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-21 22:35 [PATCHv3 0/8] fetch: make sure submodule oids are fetched Stefan Beller
2018-09-21 22:35 ` [PATCH 1/8] sha1-array: provide oid_array_filter Stefan Beller
2018-09-22 12:58 ` Ævar Arnfjörð Bjarmason
2018-09-25 19:26 ` Stefan Beller
2018-09-26 4:15 ` Jeff King
2018-09-26 17:10 ` Junio C Hamano
2018-09-26 17:49 ` Ævar Arnfjörð Bjarmason
2018-09-26 18:27 ` Junio C Hamano
2018-09-26 18:34 ` Jeff King
2018-09-26 18:43 ` Ævar Arnfjörð Bjarmason
2018-09-26 18:58 ` Jeff King
2018-09-26 19:39 ` Stefan Beller
2018-09-26 19:49 ` Junio C Hamano
2018-09-26 19:59 ` Stefan Beller
2018-09-26 20:19 ` Junio C Hamano
2018-09-26 20:51 ` Jeff King
2018-09-26 21:22 ` Stefan Beller
2018-09-26 20:44 ` On shipping more of our technical docs as manpages Ævar Arnfjörð Bjarmason
2018-09-26 21:40 ` Junio C Hamano
2018-09-26 23:21 ` Stefan Beller
2018-09-27 8:58 ` Ævar Arnfjörð Bjarmason
2018-09-27 6:20 ` Jeff King
2018-09-27 6:34 ` Jonathan Nieder
2018-09-27 6:40 ` Jeff King
2018-09-27 17:36 ` Junio C Hamano
2018-09-27 18:25 ` Jeff King
2018-09-27 21:27 ` [PATCH] Documentation/CodingGuidelines: How to document new APIs Stefan Beller
2018-09-27 21:43 ` Junio C Hamano
2018-09-27 22:21 ` Ævar Arnfjörð Bjarmason
2018-09-27 23:27 ` Jonathan Nieder
2018-09-28 1:11 ` Jeff King
2018-09-28 16:50 ` Junio C Hamano
2018-09-28 17:30 ` [PATCH] strbuf.h: format according to coding guidelines Stefan Beller
2018-09-28 19:54 ` Junio C Hamano
2018-09-28 20:11 ` Junio C Hamano [this message]
2018-09-28 21:38 ` Junio C Hamano
2018-09-29 7:38 ` Jeff King
2018-09-28 21:42 ` Junio C Hamano
2018-09-28 21:54 ` Stefan Beller
2018-09-28 19:47 ` [PATCH] Documentation/CodingGuidelines: How to document new APIs Martin Ågren
2018-09-29 7:46 ` Jeff King
2018-09-28 17:14 ` Stefan Beller
2018-09-29 7:41 ` Jeff King
2018-09-27 6:48 ` [PATCH 1/8] sha1-array: provide oid_array_filter Jeff King
2018-09-21 22:35 ` [PATCH 2/8] submodule.c: fix indentation Stefan Beller
2018-09-21 22:35 ` [PATCH 3/8] submodule.c: sort changed_submodule_names before searching it Stefan Beller
2018-09-21 22:35 ` [PATCH 4/8] submodule: move global changed_submodule_names into fetch submodule struct Stefan Beller
2018-09-21 22:35 ` [PATCH 5/8] submodule.c: do not copy around submodule list Stefan Beller
2018-09-21 22:35 ` [PATCH 6/8] submodule: fetch in submodules git directory instead of in worktree Stefan Beller
2018-09-21 22:35 ` [PATCH 7/8] fetch: retry fetching submodules if needed objects were not fetched Stefan Beller
2018-09-21 22:35 ` [PATCH 8/8] builtin/fetch: check for submodule updates for non branch fetches Stefan Beller
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqin2pbcwh.fsf@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=jrnieder@gmail.com \
--cc=peff@peff.net \
--cc=sbeller@google.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).