All of lore.kernel.org
 help / color / mirror / Atom feed
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 1/2] notes: update documentation for `use_default_notes`
Date: Sun,  4 Jun 2023 20:53:59 +0200	[thread overview]
Message-ID: <3eaa725d3a476e3cfd7331104f35bbd322d9394f.1685904424.git.code@khaugsbakk.name> (raw)
In-Reply-To: <cover.1685904424.git.code@khaugsbakk.name>

`suppress_default_notes` was renamed to `use_default_notes` in
3a03cf6b1d (notes: refactor display notes default handling,
2011-03-29).

The commit message says that “values less than one [indicates] “not
set” ”, but what was meant was probably “less than zero” (the author of
3a03cf6b1d agrees on this point).

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 notes.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/notes.h b/notes.h
index c1682c39a9..a823840e49 100644
--- a/notes.h
+++ b/notes.h
@@ -286,8 +286,9 @@ void disable_display_notes(struct display_notes_opt *opt, int *show_notes);
  * If 'opt' is not NULL, then it specifies additional settings for the
  * displaying:
  *
- * - suppress_default_notes indicates that the notes from
- *   core.notesRef and notes.displayRef should not be loaded.
+ * - 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.
-- 
2.41.0


  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   ` Kristoffer Haugsbakk [this message]
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 ` [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=3eaa725d3a476e3cfd7331104f35bbd322d9394f.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.