Skip to content

Commit 0179399

Browse files
authored
doc: update prerequisite of git node v8 on macos (#337)
1 parent 7aabb91 commit 0179399

File tree

1 file changed

+50
-32
lines changed

1 file changed

+50
-32
lines changed

docs/git-node.md

Lines changed: 50 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,54 @@
33
A custom Git command for managing pull requests. You can run it as
44
`git-node` or `git node`. To see the help text, run `git node`.
55

6-
- [Prerequistes](#prerequistes)
76
- [`git node land`](#git-node-land)
7+
- [Prerequistes](#git-node-land-prerequistes)
88
- [Git bash for Windows](#git-bash-for-windows)
99
- [Demo & Usage](#demo--usage)
1010
- [`git node backport`](#git-node-backport)
1111
- [Example](#example)
1212
- [`git node sync`](#git-node-sync)
1313
- [`git node metadata`](#git-node-metadata)
1414
- [`git node v8`](#git-node-v8)
15+
- [Prerequistes](#git-node-v8-prerequistes)
1516
- [`git node v8 major`](#git-node-v8-major)
1617
- [`git node v8 minor`](#git-node-v8-minor)
1718
- [`git node v8 backport <sha..>`](#git-node-v8-backport-sha)
1819
- [General options](#general-options)
1920
- [`git node wpt`](#git-node-wpt)
2021
- [Example](#example-1)
2122

22-
## Prerequistes
23+
## `git node land`
24+
25+
```
26+
git-node land [prid|options]
27+
28+
Manage the current landing session or start a new one for a pull request
29+
30+
Positionals:
31+
prid, options ID of the Pull Request [number]
32+
33+
Options:
34+
--version Show version number [boolean]
35+
--help Show help [boolean]
36+
--apply Apply a patch with the given PR id [number]
37+
--amend Amend the current commit [boolean]
38+
--continue, -c Continue the landing session [boolean]
39+
--final Verify the landed PR and clean up [boolean]
40+
--abort Abort the current landing session [boolean]
41+
42+
Examples:
43+
git node land 12344 Land https://github.com/nodejs/node/pull/12344 in
44+
the current directory
45+
git node land --abort Abort the current session
46+
git node land --amend Append metadata to the current commit message
47+
git node land --final Verify the landed PR and clean up
48+
git node land --continue Continue the current landing session
49+
```
50+
51+
<a id="git-node-land-prerequistes"></a>
2352

24-
Note: the prerequistes are not required for `git node v8`.
53+
### Prerequistes
2554

2655
1. See the readme on how to
2756
[set up credentials](../README.md#setting-up-credentials).
@@ -52,34 +81,6 @@ Note: the prerequistes are not required for `git node v8`.
5281
$ ncu-config set branch master
5382
```
5483

55-
## `git node land`
56-
57-
```
58-
git-node land [prid|options]
59-
60-
Manage the current landing session or start a new one for a pull request
61-
62-
Positionals:
63-
prid, options ID of the Pull Request [number]
64-
65-
Options:
66-
--version Show version number [boolean]
67-
--help Show help [boolean]
68-
--apply Apply a patch with the given PR id [number]
69-
--amend Amend the current commit [boolean]
70-
--continue, -c Continue the landing session [boolean]
71-
--final Verify the landed PR and clean up [boolean]
72-
--abort Abort the current landing session [boolean]
73-
74-
Examples:
75-
git node land 12344 Land https://github.com/nodejs/node/pull/12344 in
76-
the current directory
77-
git node land --abort Abort the current session
78-
git node land --amend Append metadata to the current commit message
79-
git node land --final Verify the landed PR and clean up
80-
git node land --continue Continue the current landing session
81-
```
82-
8384
### Git bash for Windows
8485

8586
If you are using `git bash` and having trouble with output use
@@ -232,7 +233,24 @@ git node metadata 167 --repo llnode --readme ../node/README.md
232233
## `git node v8`
233234

234235
Update or patch the V8 engine.
235-
This tool will maintain a clone of the V8 repository in `~/.update-v8/v8`.
236+
This tool will maintain a clone of the V8 repository in `~/.update-v8/v8`
237+
if it's used without `--v8-dir`.
238+
239+
<a id="git-node-v8-prerequistes"></a>
240+
241+
### Prerequistes
242+
243+
If you are on macOS, the version of `patch` command bundled in the system may
244+
be too old for `git node v8` to work. Try installing a newer version of patch
245+
before using this tool. For instance, with homebrew:
246+
247+
```
248+
$ brew install gpatch
249+
```
250+
251+
And make sure `which patch` points to `/usr/local/bin/patch` installed by
252+
homebrew instead of `/usr/bin/patch` that comes with the system (e.g. by
253+
modifying yoru `PATH` environment variable).
236254

237255
### `git node v8 major`
238256

0 commit comments

Comments
 (0)