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

[PATCH] notes.h: fix typos in comment

From
Denton Liu <liu.denton@gmail.com>
Date
Dec 18, 2019, 18:17 UTC
Message-ID
<34bbdc1af3d76f556e26ac92fff35bf2ac853470.1576692900.git.liu.denton@gmail.com>
In-Reply-To
<CAPig+cRVyfWceVZFgRuRyL-B3TMnX9fObC84t2LHsNoXm8TuqQ@mail.gmail.com>

In 1d7297513d (notes: break set_display_notes() into smaller functions, 2019-12-11), we introduced a comment which had a couple of typos. In the first typo, we referenced 'enable_default_display_notes' instead of 'enable_ref_display_notes'. In the second typo, we wrote "is a points to" instead of "is a pointer to". Correct both of these typos.

Reported-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
This patch is based on top of 'dl/format-patch-notes-config-fixup'.
Thanks for catching the typo, Eric!
 notes.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/notes.h b/notes.h
index 3e78448181..bbab1961ca 100644
--- a/notes.h
+++ b/notes.h
@@ -268,11 +268,11 @@ void init_display_notes(struct display_notes_opt *opt);
 /*
  * This family of functions enables or disables the display of notes. In
  * particular, 'enable_default_display_notes' will display the default notes,
- * 'enable_default_display_notes' will display the notes ref 'ref' and
+ * 'enable_ref_display_notes' will display the notes ref 'ref' and
  * 'disable_display_notes' will disable notes, including those added by previous
  * invocations of the 'enable_*_display_notes' functions.
  *
- * 'show_notes' is a points to a boolean which will be set to 1 if notes are
+ * 'show_notes' is a pointer to a boolean which will be set to 1 if notes are
  * displayed, else 0. It must not be NULL.
  */
 void enable_default_display_notes(struct display_notes_opt *opt, int *show_notes);
-- 
2.24.1.703.g2f499f1283
Previous: Eric Sunshine
Message 5 of 5 in “dl/format-patch-notes-config-fixup: clean up some leftoverbits”
  1. 0/2 dl/format-patch-notes-config-fixup: clean up some leftoverbitsDenton Liu, Dec 12, 2019
  2. 1/2 config/format.txt: clarify behavior of multiple format.notesDenton Liu, Dec 12, 2019
  3. 2/2 notes: break set_display_notes() into smaller functionsDenton Liu, Dec 12, 2019
  4. Eric SunshineDec 18, 2019
  5. notes.h: fix typos in commentDenton Liu, Dec 18, 2019

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.