git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] strbuf.h: format according to coding guidelines

From
Stefan Beller <sbeller@google.com>
Date
Sep 28, 2018, 21:54 UTC
Message-ID
<CAGZ79kbV6QjsFKcD2uG_P9j1AvzSNQSi-_jXGQ9w0YU9fjhEGg@mail.gmail.com>
In-Reply-To
<xmqq4le9b8p6.fsf@gitster-ct.c.googlers.com>
On Fri, Sep 28, 2018 at 2:42 PM Junio C Hamano <gitster@pobox.com> wrote:
Show 25 quoted lines
>
> Stefan Beller <sbeller@google.com> writes:
>
> > The previous patch suggested the strbuf header to be the leading example
> > of how we would want our APIs to be documented. This may lead to some
> > scrutiny of that code and the coding style (which is different from the
> > API documentation style) and hence might be taken as an example on how
> > to format code as well.
> >
> > So let's format strbuf.h in a way that we'd like to see:
> > * omit the extern keyword from function declarations
> > * name all parameters (usually the parameters are obvious from its type,
> >   but consider exceptions like
> >   `int strbuf_getwholeline_fd(struct strbuf *, int, int);`
> > * break overly long lines
> >
> > Signed-off-by: Stefan Beller <sbeller@google.com>
> > ---
> >
> > Maybe this on top of Junios guideline patch?
>
> If we were to do this, I'd rather see us do a very good job on this
> file first, with "We are going to use this file as the best current
> practice model for an API header file" to begin its log message,
> and then recommend its use as the model on top.

I started going through that file and undoing "the naming all parameters" and additionally started to remove any obvious parameter name (mostly the first argument, that is of struct strbuf, and sometimes was called sb or out)

But it seems in addition to all this we also want to re-read the documentation and make sure it reflects the API accurately and describes it well.

Previous: Junio C HamanoNext: Martin Ågren
Message 39 of 51 in “[PATCHv3 0/8] fetch: make sure submodule oids are fetched”
  1. Stefan BellerSep 21, 2018
  2. 1/8 sha1-array: provide oid_array_filterStefan Beller, Sep 21, 2018
  3. Ævar Arnfjörð BjarmasonSep 22, 2018
  4. Stefan BellerSep 25, 2018
  5. Jeff KingSep 26, 2018
  6. Junio C HamanoSep 26, 2018
  7. Ævar Arnfjörð BjarmasonSep 26, 2018
  8. Junio C HamanoSep 26, 2018
  9. Jeff KingSep 26, 2018
  10. Ævar Arnfjörð BjarmasonSep 26, 2018
  11. Jeff KingSep 26, 2018
  12. Stefan BellerSep 26, 2018
  13. Junio C HamanoSep 26, 2018
  14. Stefan BellerSep 26, 2018
  15. Junio C HamanoSep 26, 2018
  16. Jeff KingSep 26, 2018
  17. Stefan BellerSep 26, 2018
  18. On shipping more of our technical docs as manpagesÆvar Arnfjörð Bjarmason, Sep 26, 2018
  19. Junio C HamanoSep 26, 2018
  20. Stefan BellerSep 26, 2018
  21. Ævar Arnfjörð BjarmasonSep 27, 2018
  22. Jeff KingSep 27, 2018
  23. Jonathan NiederSep 27, 2018
  24. Jeff KingSep 27, 2018
  25. Junio C HamanoSep 27, 2018
  26. Jeff KingSep 27, 2018
  27. Documentation/CodingGuidelines: How to document new APIsStefan Beller, Sep 27, 2018
  28. Junio C HamanoSep 27, 2018
  29. Ævar Arnfjörð BjarmasonSep 27, 2018
  30. Jonathan NiederSep 27, 2018
  31. Jeff KingSep 28, 2018
  32. Junio C HamanoSep 28, 2018
  33. strbuf.h: format according to coding guidelinesStefan Beller, Sep 28, 2018
  34. Junio C HamanoSep 28, 2018
  35. Junio C HamanoSep 28, 2018
  36. Junio C HamanoSep 28, 2018
  37. Jeff KingSep 29, 2018
  38. Junio C HamanoSep 28, 2018
  39. Stefan BellerSep 28, 2018
  40. Martin ÅgrenSep 28, 2018
  41. Jeff KingSep 29, 2018
  42. Stefan BellerSep 28, 2018
  43. Jeff KingSep 29, 2018
  44. Jeff KingSep 27, 2018
  45. 2/8 submodule.c: fix indentationStefan Beller, Sep 21, 2018
  46. 3/8 submodule.c: sort changed_submodule_names before searching itStefan Beller, Sep 21, 2018
  47. 4/8 submodule: move global changed_submodule_names into fetch submodule structStefan Beller, Sep 21, 2018
  48. 5/8 submodule.c: do not copy around submodule listStefan Beller, Sep 21, 2018
  49. 6/8 submodule: fetch in submodules git directory instead of in worktreeStefan Beller, Sep 21, 2018
  50. 7/8 fetch: retry fetching submodules if needed objects were not fetchedStefan Beller, Sep 21, 2018
  51. 8/8 builtin/fetch: check for submodule updates for non branch fetchesStefan Beller, Sep 21, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.