Skip to content

Commit b77c91a

Browse files
committed
Merge branch 'sp/myfirstcontribution-include-update'
Doc update. * sp/myfirstcontribution-include-update: doc: MyFirstContribution: fix missing dependencies and clarify build steps
2 parents d62717b + 8102187 commit b77c91a

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

Documentation/MyFirstContribution.adoc

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,8 @@ on the command line, including the name of our command. (If `prefix` is empty
331331
for you, try `cd Documentation/ && ../bin-wrappers/git psuh`). That's not so
332332
helpful. So what other context can we get?
333333

334-
Add a line to `#include "config.h"` and `#include "repository.h"`.
334+
Add a line to `#include "config.h"`, `#include "repository.h"` and
335+
`#include "environment.h"`.
335336
Then, add the following bits to the function body:
336337
function body:
337338

@@ -429,6 +430,7 @@ Add the following includes:
429430
----
430431
#include "commit.h"
431432
#include "pretty.h"
433+
#include "strbuf.h"
432434
----
433435

434436
Then, add the following lines within your implementation of `cmd_psuh()` near
@@ -503,8 +505,8 @@ git-psuh - Delight users' typo with a shy horse
503505
504506
SYNOPSIS
505507
--------
506-
[verse]
507-
'git-psuh [<arg>...]'
508+
[synopsis]
509+
git psuh [<arg>...]
508510
509511
DESCRIPTION
510512
-----------
@@ -726,9 +728,10 @@ $ prove -j$(nproc) --shuffle t[0-9]*.sh
726728
----
727729

728730
NOTE: You can also do this with `make test` or use any testing harness which can
729-
speak TAP. `prove` can run concurrently. `shuffle` randomizes the order the
730-
tests are run in, which makes them resilient against unwanted inter-test
731-
dependencies. `prove` also makes the output nicer.
731+
speak TAP. `prove` can run concurrently. `-j$(nproc)` runs tests using all
732+
available CPUs in parallel, but the job count can be adjusted as needed.
733+
`shuffle` randomizes the order the tests are run in, which makes them resilient
734+
against unwanted inter-test dependencies. `prove` also makes the output nicer.
732735

733736
Go ahead and commit this change, as well.
734737

0 commit comments

Comments
 (0)