From: Shreyansh Paliwal <shreyanshpaliwalcmsmn@gmail•com>
To: git@vger•kernel.org
Cc: gitster@pobox•com, Shreyansh Paliwal <shreyanshpaliwalcmsmn@gmail•com>
Subject: [PATCH] doc: MyFirstContribution: fix missing dependencies and clarify build steps
Date: Mon, 12 Jan 2026 15:10:23 +0530 [thread overview]
Message-ID: <20260112094030.314203-1-shreyanshpaliwalcmsmn@gmail.com> (raw)
In-Reply-To: <20260108174651.1618874-1-shreyanshpaliwalcmsmn@gmail.com>
Fix several issues in the MyFirstContribution guide that can lead to
confusion or test failures when following the documented steps.
* Add missing header includes in code examples (environment.h and
strbuf.h).
* correct manpage synopsis formatting to prevent failing documentation tests.
* clarify documentation build prerequisites, particularly specifying for DocBook-XSL.
* specify the use of parallel test execution with -j$(nproc), noting that
it runs tests using all available CPUs and may be adjusted.
These updates improve accuracy and make the first-time contributor
journey smoother.
Signed-off-by: Shreyansh Paliwal <shreyanshpaliwalcmsmn@gmail•com>
---
Documentation/MyFirstContribution.adoc | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index f186dfbc89..38f2a23e77 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -331,7 +331,8 @@ on the command line, including the name of our command. (If `prefix` is empty
for you, try `cd Documentation/ && ../bin-wrappers/git psuh`). That's not so
helpful. So what other context can we get?
-Add a line to `#include "config.h"` and `#include "repository.h"`.
+Add a line to `#include "config.h"`, `#include "repository.h"` and
+`#include "environment.h"`.
Then, add the following bits to the function body:
function body:
@@ -429,6 +430,7 @@ Add the following includes:
----
#include "commit.h"
#include "pretty.h"
+#include "strbuf.h"
----
Then, add the following lines within your implementation of `cmd_psuh()` near
@@ -504,7 +506,7 @@ git-psuh - Delight users' typo with a shy horse
SYNOPSIS
--------
[verse]
-'git-psuh [<arg>...]'
+git psuh [<arg>...]
DESCRIPTION
-----------
@@ -531,7 +533,7 @@ easier for your user, who can skip to the section they know contains the
information they need.
NOTE: Before trying to build the docs, make sure you have the package `asciidoc`
-installed.
+and `docbook-xsl` installed. See `INSTALL` for details.
Now that you've written your manpage, you'll need to build it explicitly. We
convert your AsciiDoc to troff which is man-readable like so:
@@ -726,9 +728,10 @@ $ prove -j$(nproc) --shuffle t[0-9]*.sh
----
NOTE: You can also do this with `make test` or use any testing harness which can
-speak TAP. `prove` can run concurrently. `shuffle` randomizes the order the
-tests are run in, which makes them resilient against unwanted inter-test
-dependencies. `prove` also makes the output nicer.
+speak TAP. `prove` can run concurrently. `-j$(nproc)` runs tests using all
+available CPUs in parallel, but the job count can be adjusted as needed.
+`shuffle` randomizes the order the tests are run in, which makes them resilient
+against unwanted inter-test dependencies. `prove` also makes the output nicer.
Go ahead and commit this change, as well.
--
2.43.0
next prev parent reply other threads:[~2026-01-12 9:40 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-08 17:40 [PATCH] Documentation/MyFirstContribution: add missing dependencies and clarify build steps Shreyansh Paliwal
2026-01-12 9:40 ` Shreyansh Paliwal [this message]
2026-01-12 12:55 ` [PATCH] doc: MyFirstContribution: fix " Pushkar Singh
2026-01-12 16:05 ` Shreyansh Paliwal
2026-01-12 14:34 ` Junio C Hamano
2026-01-12 16:11 ` Shreyansh Paliwal
2026-01-12 18:51 ` Junio C Hamano
2026-01-12 19:10 ` Shreyansh Paliwal
2026-01-12 19:53 ` [PATCH v2] " Shreyansh Paliwal
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=20260112094030.314203-1-shreyanshpaliwalcmsmn@gmail.com \
--to=shreyanshpaliwalcmsmn@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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