git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: K Jayatheerth <jayatheerthkulkarni2005@gmail.com>
To: nasamuffin@google.com
Cc: git@vger.kernel.org, gitster@pobox.com,
	jayatheerthkulkarni2005@gmail.com
Subject: [PATCH v2 2/3] docs: clarify cmd_psuh signature and explain UNUSED macro
Date: Sat, 17 May 2025 00:25:15 +0530	[thread overview]
Message-ID: <20250516185516.52311-2-jayatheerthkulkarni2005@gmail.com> (raw)
In-Reply-To: <20250516185516.52311-1-jayatheerthkulkarni2005@gmail.com>

The documentation previously omitted the UNUSED macro,
which often led to confusion for new contributors
when they encountered compiler warnings related to unused parameters.
This commit adds a brief explanation to help clarify its
purpose and common usage in the Git codebase.

Additionally, the function signature for cmd_psuh has been updated
to include the struct repository *repo argument,
aligning it with the standard pattern for built-in commands.

Signed-off-by: K Jayatheerth <jayatheerthkulkarni2005@gmail.com>
---
 Documentation/MyFirstContribution.adoc | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index ef190d8748..f4320d8869 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -142,7 +142,15 @@ command in `builtin/psuh.c`. Create that file, and within it, write the entry
 point for your command in a function matching the style and signature:
 
 ----
-int cmd_psuh(int argc, const char **argv, const char *prefix)
+int cmd_psuh(int argc, const char **argv, const char *prefix, struct repository *repo)
+----
+
+We will use the UNUSED macro to make sure we don't recieve compiler warnings
+for unused arguments from the function cmd_psuh.
+
+----
+int cmd_psuh(int argc UNUSED, const char **argv UNUSED,
+	    const char *prefix UNUSED, struct repository *repo UNUSED)
 ----
 
 We'll also need to add the declaration of psuh; open up `builtin.h`, find the
@@ -150,7 +158,7 @@ declaration for `cmd_pull`, and add a new line for `psuh` immediately before it,
 in order to keep the declarations alphabetically sorted:
 
 ----
-int cmd_psuh(int argc, const char **argv, const char *prefix);
+int cmd_psuh(int argc, const char **argv, const char *prefix, struct repository *repo);
 ----
 
 Be sure to `#include "builtin.h"` in your `psuh.c`. You'll also need to
@@ -166,7 +174,8 @@ Throughout the tutorial, we will mark strings for translation as necessary; you
 should also do so when writing your user-facing commands in the future.
 
 ----
-int cmd_psuh(int argc, const char **argv, const char *prefix)
+int cmd_psuh(int argc UNUSED, const char **argv UNUSED, 
+	    const char *prefix UNUSED, struct repository *repo UNUSED)
 {
 	printf(_("Pony saying hello goes here.\n"));
 	return 0;
@@ -279,8 +288,9 @@ on the reference implementation linked at the top of this document.
 It's probably useful to do at least something besides printing out a string.
 Let's start by having a look at everything we get.
 
-Modify your `cmd_psuh` implementation to dump the args you're passed, keeping
-existing `printf()` calls in place:
+Modify your `cmd_psuh` implementation to dump the args you're passed,
+keeping existing `printf()` calls in place; because the args are now
+used, remove the `UNUSED` macro from them:
 
 ----
 	int i;
-- 
2.49.GIT


  reply	other threads:[~2025-05-16 18:55 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-16  6:14 [PATCH 0/4] update MyFirstContribution with current code base K Jayatheerth
2025-04-16  6:14 ` [PATCH 1/4] Remove unused git-mentoring mailing list K Jayatheerth
2025-04-16  6:14 ` [PATCH 2/4] Docs: Correct cmd_psuh and Explain UNUSED macro K Jayatheerth
2025-05-16 18:08   ` Emily Shaffer
2025-04-16  6:14 ` [PATCH 3/4] Docs: Add cmd_psuh with repo and UNUSED removal K Jayatheerth
2025-05-16 18:12   ` Emily Shaffer
2025-05-16 18:55     ` [PATCH v2 1/3] docs: remove unused mentoring mailing list reference K Jayatheerth
2025-05-16 18:55       ` K Jayatheerth [this message]
2025-05-17 13:39         ` [PATCH v2 2/3] docs: clarify cmd_psuh signature and explain UNUSED macro Junio C Hamano
2025-05-17 18:39           ` Junio C Hamano
2025-05-18  7:34             ` [PATCH v3 0/3] Update MyFirstContribution.adoc to follow modern practices K Jayatheerth
2025-05-18  7:34               ` [PATCH v3 1/3] docs: remove unused mentoring mailing list reference K Jayatheerth
2025-05-18  7:34               ` [PATCH v3 2/3] docs: clarify cmd_psuh signature and explain UNUSED macro K Jayatheerth
2025-05-18  7:34               ` [PATCH v3 3/3] docs: replace git_config to repo_config K Jayatheerth
2025-05-18  7:40                 ` JAYATHEERTH K
2025-05-16 18:55       ` [PATCH v2 " K Jayatheerth
2025-05-17 13:39         ` Junio C Hamano
2025-05-16 20:57       ` [PATCH v2 1/3] docs: remove unused mentoring mailing list reference Emily Shaffer
2025-05-17  1:19       ` Junio C Hamano
2025-05-17  3:36         ` [PATCH v3 0/3] Update MyFirstContribution.adoc to follow modern practices K Jayatheerth
2025-05-17  3:36           ` [PATCH v3 1/3] docs: remove unused mentoring mailing list reference K Jayatheerth
2025-05-17  3:36           ` [PATCH v3 2/3] docs: clarify cmd_psuh signature and explain UNUSED macro K Jayatheerth
2025-05-17  3:36           ` [PATCH v3 3/3] docs: replace git_config to repo_config K Jayatheerth
2025-04-16  6:14 ` [PATCH 4/4] cmd_psuh: Prefer repo_config for config lookup K Jayatheerth
2025-05-16 18:26   ` Emily Shaffer
2025-05-16 19:06     ` JAYATHEERTH K
2025-04-16 14:16 ` [PATCH 0/4] update MyFirstContribution with current code base Junio C Hamano
2025-04-16 14:38   ` JAYATHEERTH K
2025-05-13 11:17     ` JAYATHEERTH K
2025-05-14 12:48     ` Junio C Hamano
2025-05-14 13:06       ` JAYATHEERTH K
2025-05-15 22:38         ` Emily Shaffer
2025-05-16  8:20           ` JAYATHEERTH K
2025-05-16 16:11             ` Junio C Hamano
2025-05-16 17:18               ` JAYATHEERTH K
2025-05-20 14:15               ` D. Ben Knoble
2025-05-17 18:24             ` Junio C Hamano

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=20250516185516.52311-2-jayatheerthkulkarni2005@gmail.com \
    --to=jayatheerthkulkarni2005@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=nasamuffin@google.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 NNTP newsgroup(s).