From: Jeff King <peff@peff.net>
To: Kristoffer Haugsbakk <code@khaugsbakk.name>
Cc: Junio C Hamano <gitster@pobox.com>, git@vger.kernel.org
Subject: Re: [PATCH v3 2/2] notes: move the documentation to the struct
Date: Mon, 5 Jun 2023 00:50:42 -0400 [thread overview]
Message-ID: <20230605045042.GA66000@coredump.intra.peff.net> (raw)
In-Reply-To: <99c88c74ceab751c0540b51d98bf339bffc098ef.1685904424.git.code@khaugsbakk.name>
On Sun, Jun 04, 2023 at 08:54:00PM +0200, Kristoffer Haugsbakk wrote:
> Its better to document the struct members on the struct definition
> instead of on a function that takes a pointer to such a struct. This
> will also make it easier to update the documentation in the future.
This is better, I think, but...
> +/*
> + * - use_default_notes: less than `0` is "unset", which means that the
> + * default notes are shown iff no other notes are given. Otherwise,
> + * treat it like a boolean.
> + *
> + * - extra_notes_refs may contain a list of globs (in the same style
> + * as notes.displayRef) where notes should be loaded from.
> + */
> struct display_notes_opt {
> int use_default_notes;
> struct string_list extra_notes_refs;
...what I had meant to suggest was putting the documentation next to
each field, like:
struct foo {
/* when set, enable "bar" for all frotz's */
int use_bar;
/* etc... */
};
For an example, try "struct bloom_filter_settings" in bloom.h (though
there are many others, too).
-Peff
> @@ -283,15 +291,7 @@ void disable_display_notes(struct display_notes_opt *opt, int *show_notes);
> /*
> * Load the notes machinery for displaying several notes trees.
> *
> - * If 'opt' is not NULL, then it specifies additional settings for the
> - * displaying:
> - *
> - * - use_default_notes: less than `0` is "unset", which means that the
> - * default notes are shown iff no other notes are given. Otherwise,
> - * treat it like a boolean.
> - *
> - * - extra_notes_refs may contain a list of globs (in the same style
> - * as notes.displayRef) where notes should be loaded from.
> + * 'opt' may be NULL.
> */
> void load_display_notes(struct display_notes_opt *opt);
>
> --
> 2.41.0
>
next prev parent reply other threads:[~2023-06-05 4:50 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-31 9:52 [PATCH] notes: update documentation for `use_default_notes` Kristoffer Haugsbakk
2023-05-31 12:14 ` [PATCH v2] " Kristoffer Haugsbakk
2023-06-01 17:52 ` Jeff King
2023-06-02 10:09 ` Kristoffer Haugsbakk
2023-06-04 18:53 ` [PATCH v3 0/2] " Kristoffer Haugsbakk
2023-06-04 18:53 ` [PATCH v3 1/2] " Kristoffer Haugsbakk
2023-06-04 18:54 ` [PATCH v3 2/2] notes: move the documentation to the struct Kristoffer Haugsbakk
2023-06-05 4:50 ` Jeff King [this message]
2023-06-05 10:07 ` Kristoffer Haugsbakk
2023-06-05 10:05 ` [PATCH v4 0/2] notes: update documentation for `use_default_notes` Kristoffer Haugsbakk
2023-06-05 10:05 ` [PATCH v4 1/2] " Kristoffer Haugsbakk
2023-06-05 10:05 ` [PATCH v4 2/2] notes: move the documentation to the struct Kristoffer Haugsbakk
2023-06-06 1:57 ` [PATCH v4 0/2] notes: update documentation for `use_default_notes` Jeff King
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=20230605045042.GA66000@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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.
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).