From: Kristoffer Haugsbakk <code@khaugsbakk.name>
To: Junio C Hamano <gitster@pobox.com>
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>,
Jeff King <peff@peff.net>,
git@vger.kernel.org
Subject: [PATCH v3 2/2] notes: move the documentation to the struct
Date: Sun, 4 Jun 2023 20:54:00 +0200 [thread overview]
Message-ID: <99c88c74ceab751c0540b51d98bf339bffc098ef.1685904424.git.code@khaugsbakk.name> (raw)
In-Reply-To: <cover.1685904424.git.code@khaugsbakk.name>
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.
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/
notes.h | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/notes.h b/notes.h
index a823840e49..c63b275d7a 100644
--- a/notes.h
+++ b/notes.h
@@ -255,6 +255,14 @@ 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 {
int use_default_notes;
struct string_list extra_notes_refs;
@@ -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-04 18:55 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 ` Kristoffer Haugsbakk [this message]
2023-06-05 4:50 ` [PATCH v3 2/2] notes: move the documentation to the struct Jeff King
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=99c88c74ceab751c0540b51d98bf339bffc098ef.1685904424.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 read-only IMAP folder(s) and NNTP newsgroup(s).