Skip to content

Commit 317426a

Browse files
BridgeARMylesBorins
authored andcommitted
doc: use consistent new lines
PR-URL: #17722 Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>
1 parent 5e098a7 commit 317426a

5 files changed

+9
-4
lines changed

doc/guides/maintaining-V8.md

+1
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,7 @@ Original commit message:
275275
Refs: https://github.com/v8/v8/commit/a51f429772d1e796744244128c9feeab4c26a854
276276
PR-URL: https://github.com/nodejs/node/pull/7833
277277
```
278+
278279
* Open a PR against the `v6.x-staging` branch in the Node.js repo. Launch the
279280
normal and [V8 CI] using the Node.js CI system. We only needed to backport to
280281
`v6.x` as the other LTS branches weren't affected by this bug.

doc/guides/writing-and-running-benchmarks.md

+2
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ arrays/zero-int.js n=25 type=Buffer: 90.49906662339653
144144
```
145145

146146
It is possible to execute more groups by adding extra process arguments.
147+
147148
```console
148149
$ node benchmark/run.js arrays buffers
149150
```
@@ -439,6 +440,7 @@ function main(conf) {
439440
```
440441

441442
Supported options keys are:
443+
442444
* `port` - defaults to `common.PORT`
443445
* `path` - defaults to `/`
444446
* `connections` - number of concurrent connections to use, defaults to 100

doc/guides/writing-tests.md

+5
Original file line numberDiff line numberDiff line change
@@ -306,12 +306,14 @@ the upstream project, send another PR here to update Node.js accordingly.
306306
Be sure to update the hash in the URL following `WPT Refs:`.
307307

308308
## C++ Unit test
309+
309310
C++ code can be tested using [Google Test][]. Most features in Node.js can be
310311
tested using the methods described previously in this document. But there are
311312
cases where these might not be enough, for example writing code for Node.js
312313
that will only be called when Node.js is embedded.
313314

314315
### Adding a new test
316+
315317
The unit test should be placed in `test/cctest` and be named with the prefix
316318
`test` followed by the name of unit being tested. For example, the code below
317319
would be placed in `test/cctest/test_env.cc`:
@@ -345,18 +347,21 @@ static void at_exit_callback(void* arg) {
345347
```
346348
347349
Next add the test to the `sources` in the `cctest` target in node.gyp:
350+
348351
```console
349352
'sources': [
350353
'test/cctest/test_env.cc',
351354
...
352355
],
353356
```
357+
354358
Note that the only sources that should be included in the cctest target are
355359
actual test or helper source files. There might be a need to include specific
356360
object files that are compiled by the `node` target and this can be done by
357361
adding them to the `libraries` section in the cctest target.
358362

359363
The test can be executed by running the `cctest` target:
364+
360365
```console
361366
$ make cctest
362367
```

doc/onboarding-extras.md

-4
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ When things need extra attention, are controversial, or `semver-major`:
4747

4848
If you cannot find who to cc for a file, `git shortlog -n -s <file>` may help.
4949

50-
5150
## Labels
5251

5352
### By Subsystem
@@ -64,7 +63,6 @@ part(s) of the codebase it touches.
6463

6564
There may be more than one subsystem valid for any particular issue / PR.
6665

67-
6866
### General
6967

7068
Please use these when possible / appropriate
@@ -136,7 +134,6 @@ need to be attached anymore, as only important bugfixes will be included.
136134
* `arm`, `mips`, `s390`, `ppc`
137135
* No x86{_64}, since that is the implied default
138136

139-
140137
## Updating Node.js from Upstream
141138

142139
* `git remote add upstream git://github.com/nodejs/node.git`
@@ -147,7 +144,6 @@ to update from nodejs/node:
147144
* `git remote update -p` OR `git fetch --all` (I prefer the former)
148145
* `git merge --ff-only upstream/master` (or `REMOTENAME/BRANCH`)
149146

150-
151147
## best practices
152148

153149
* commit often, out to your github fork (origin), open a PR

doc/onboarding.md

+1
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ onboarding session.
107107
[here](https://github.com/nodejs/TSC/blob/master/Moderation-Policy.md).
108108

109109
## Reviewing PRs
110+
110111
* The primary goal is for the codebase to improve.
111112
* Secondary (but not far off) is for the person submitting code to succeed. A
112113
pull request from a new contributor is an opportunity to grow the community.

0 commit comments

Comments
 (0)