From: Kristoffer Haugsbakk <code@khaugsbakk.name>
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>,
Jeff King <peff@peff.net>, Junio C Hamano <gitster@pobox.com>
Subject: [PATCH v4 0/2] notes: update documentation for `use_default_notes`
Date: Mon, 5 Jun 2023 12:05:21 +0200 [thread overview]
Message-ID: <cover.1685958731.git.code@khaugsbakk.name> (raw)
In-Reply-To: <b3829cb0d1e36a5ebb44a315fe32037f2a3f6c7a.1685526558.git.code@khaugsbakk.name>
While I was working on [1] I found that the doc for the struct
`display_notes_opt` hadn’t been updated when one of the members were
renamed. I chose to post a separate patch/series.
[1] https://lore.kernel.org/git/cover.1685441207.git.code@khaugsbakk.name
§ Changes in v4 by patch
• 2: Document the struct members directly
Kristoffer Haugsbakk (2):
notes: update documentation for `use_default_notes`
notes: move the documentation to the struct
notes.h | 19 +++++++++++--------
1 file changed, 11 insertions(+), 8 deletions(-)
Range-diff against v3:
-: ---------- > 1: 3eaa725d3a notes: update documentation for `use_default_notes`
1: 99c88c74ce ! 2: ba147707ef notes: move the documentation to the struct
@@ Metadata
## Commit message ##
notes: move the documentation to the struct
- 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.
+ Its better to document the struct members directly instead of on a
+ function that takes a pointer to the struct. This will also make it
+ easier to update the documentation in the future.
+
+ Make adjustments for this new context. Also drop “may contain” since we
+ don’t need to emphasize that a list could be empty.
Suggested-by: Jeff King <peff@peff.net>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
## Notes (series) ##
- Suggested in: https://lore.kernel.org/git/20230601175218.GB4165405@coredump.intra.peff.net/
+ v3: Suggested in: https://lore.kernel.org/git/20230601175218.GB4165405@coredump.intra.peff.net/
+ v4:
+ • Put docs on each member instead
+ • Update commit message accordingly
+ • Drop “may contain” since we don’t have to emphasize that a list
+ could be empty
+ • Formatting is based on clang-format and `bloom_filter_settings` in
+ `bloom.h`
## notes.h ##
@@ notes.h: void free_notes(struct notes_tree *t);
-
struct string_list;
-+/*
-+ * - 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 {
++ /*
++ * 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.
++ */
int use_default_notes;
++
++ /*
++ * A list of globs (in the same style as notes.displayRef) where
++ * notes should be loaded from.
++ */
struct string_list extra_notes_refs;
+ };
+
@@ notes.h: void disable_display_notes(struct display_notes_opt *opt, int *show_notes);
/*
* Load the notes machinery for displaying several notes trees.
--
2.41.0
next prev parent reply other threads:[~2023-06-05 10:06 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
2023-06-05 10:07 ` Kristoffer Haugsbakk
2023-06-05 10:05 ` Kristoffer Haugsbakk [this message]
2023-06-05 10:05 ` [PATCH v4 1/2] notes: update documentation for `use_default_notes` 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=cover.1685958731.git.code@khaugsbakk.name \
--to=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
/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).