Skip to content

Commit bf08c08

Browse files
nschonniBridgeAR
authored andcommitted
doc: use consistent unordered list style
Convert to asterisks when there are mixed styles in document. Addresses Markdownlint MD004 rule PR-URL: #29516 Reviewed-By: David Carlier <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent a268658 commit bf08c08

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1859
-1863
lines changed

COLLABORATOR_GUIDE.md

+31-31
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,35 @@
33
## Contents
44

55
* [Issues and Pull Requests](#issues-and-pull-requests)
6-
- [Welcoming First-Time Contributors](#welcoming-first-time-contributors)
7-
- [Closing Issues and Pull Requests](#closing-issues-and-pull-requests)
8-
- [Author ready pull requests](#author-ready-pull-requests)
9-
- [Handling own pull requests](#handling-own-pull-requests)
6+
* [Welcoming First-Time Contributors](#welcoming-first-time-contributors)
7+
* [Closing Issues and Pull Requests](#closing-issues-and-pull-requests)
8+
* [Author ready pull requests](#author-ready-pull-requests)
9+
* [Handling own pull requests](#handling-own-pull-requests)
1010
* [Accepting Modifications](#accepting-modifications)
11-
- [Code Reviews](#code-reviews)
12-
- [Consensus Seeking](#consensus-seeking)
13-
- [Waiting for Approvals](#waiting-for-approvals)
14-
- [Testing and CI](#testing-and-ci)
15-
- [Useful CI Jobs](#useful-ci-jobs)
16-
- [Internal vs. Public API](#internal-vs-public-api)
17-
- [Breaking Changes](#breaking-changes)
18-
- [Breaking Changes and Deprecations](#breaking-changes-and-deprecations)
19-
- [Breaking Changes to Internal Elements](#breaking-changes-to-internal-elements)
20-
- [Unintended Breaking Changes](#unintended-breaking-changes)
21-
- [Reverting commits](#reverting-commits)
22-
- [Introducing New Modules](#introducing-new-modules)
23-
- [Additions to N-API](#additions-to-n-api)
24-
- [Deprecations](#deprecations)
25-
- [Involving the TSC](#involving-the-tsc)
11+
* [Code Reviews](#code-reviews)
12+
* [Consensus Seeking](#consensus-seeking)
13+
* [Waiting for Approvals](#waiting-for-approvals)
14+
* [Testing and CI](#testing-and-ci)
15+
* [Useful CI Jobs](#useful-ci-jobs)
16+
* [Internal vs. Public API](#internal-vs-public-api)
17+
* [Breaking Changes](#breaking-changes)
18+
* [Breaking Changes and Deprecations](#breaking-changes-and-deprecations)
19+
* [Breaking Changes to Internal Elements](#breaking-changes-to-internal-elements)
20+
* [Unintended Breaking Changes](#unintended-breaking-changes)
21+
* [Reverting commits](#reverting-commits)
22+
* [Introducing New Modules](#introducing-new-modules)
23+
* [Additions to N-API](#additions-to-n-api)
24+
* [Deprecations](#deprecations)
25+
* [Involving the TSC](#involving-the-tsc)
2626
* [Landing Pull Requests](#landing-pull-requests)
27-
- [Using `git-node`](#using-git-node)
28-
- [Technical HOWTO](#technical-howto)
29-
- [Troubleshooting](#troubleshooting)
30-
- [I Made a Mistake](#i-made-a-mistake)
31-
- [Long Term Support](#long-term-support)
32-
- [What is LTS?](#what-is-lts)
33-
- [How are LTS Branches Managed?](#how-are-lts-branches-managed)
34-
- [How can I help?](#how-can-i-help)
27+
* [Using `git-node`](#using-git-node)
28+
* [Technical HOWTO](#technical-howto)
29+
* [Troubleshooting](#troubleshooting)
30+
* [I Made a Mistake](#i-made-a-mistake)
31+
* [Long Term Support](#long-term-support)
32+
* [What is LTS?](#what-is-lts)
33+
* [How are LTS Branches Managed?](#how-are-lts-branches-managed)
34+
* [How can I help?](#how-can-i-help)
3535
* [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker)
3636

3737
This document explains how Collaborators manage the Node.js project.
@@ -371,10 +371,10 @@ deprecation level of an API.
371371
Collaborators may opt to elevate pull requests or issues to the [TSC][].
372372
Do this if a pull request or issue:
373373

374-
- is labeled `semver-major`, or
375-
- has a significant impact on the codebase, or
376-
- is controversial, or
377-
- is at an impasse among Collaborators who are participating in the discussion.
374+
* is labeled `semver-major`, or
375+
* has a significant impact on the codebase, or
376+
* is controversial, or
377+
* is at an impasse among Collaborators who are participating in the discussion.
378378

379379
@-mention the `@nodejs/tsc` GitHub team if you want to elevate an issue to the
380380
[TSC][]. Do not use the GitHub UI on the right-hand side to assign to

CPP_STYLE_GUIDE.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,8 @@ class FancyContainer {
191191

192192
### Memory allocation
193193

194-
- `Malloc()`, `Calloc()`, etc. from `util.h` abort in Out-of-Memory situations
195-
- `UncheckedMalloc()`, etc. return `nullptr` in OOM situations
194+
* `Malloc()`, `Calloc()`, etc. from `util.h` abort in Out-of-Memory situations
195+
* `UncheckedMalloc()`, etc. return `nullptr` in OOM situations
196196

197197
### Use `nullptr` instead of `NULL` or `0`
198198

@@ -278,10 +278,10 @@ data[0] = 12345;
278278

279279
### Type casting
280280

281-
- Use `static_cast<T>` if casting is required, and it is valid
282-
- Use `reinterpret_cast` only when it is necessary
283-
- Avoid C-style casts (`(type)value`)
284-
- `dynamic_cast` does not work because Node.js is built without
281+
* Use `static_cast<T>` if casting is required, and it is valid
282+
* Use `reinterpret_cast` only when it is necessary
283+
* Avoid C-style casts (`(type)value`)
284+
* `dynamic_cast` does not work because Node.js is built without
285285
[Run Time Type Information][]
286286

287287
Further reading:

GOVERNANCE.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
<!-- TOC -->
44

5-
- [Collaborators](#collaborators)
6-
- [Collaborator Activities](#collaborator-activities)
7-
- [Technical Steering Committee](#technical-steering-committee)
8-
- [TSC Meetings](#tsc-meetings)
9-
- [Collaborator Nominations](#collaborator-nominations)
10-
- [Onboarding](#onboarding)
11-
- [Consensus Seeking Process](#consensus-seeking-process)
5+
* [Collaborators](#collaborators)
6+
* [Collaborator Activities](#collaborator-activities)
7+
* [Technical Steering Committee](#technical-steering-committee)
8+
* [TSC Meetings](#tsc-meetings)
9+
* [Collaborator Nominations](#collaborator-nominations)
10+
* [Onboarding](#onboarding)
11+
* [Consensus Seeking Process](#consensus-seeking-process)
1212

1313
<!-- /TOC -->
1414

SECURITY.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,22 @@ nonetheless.
1414

1515
## Public disclosure preferred
1616

17-
- [#14519](https://github.com/nodejs/node/issues/14519): _Internal domain
17+
* [#14519](https://github.com/nodejs/node/issues/14519): _Internal domain
1818
function can be used to cause segfaults_. Requires the ability to execute
1919
arbitrary JavaScript code. That is already the highest level of privilege
2020
possible.
2121

2222
## Private disclosure preferred
2323

24-
- [CVE-2016-7099](https://nodejs.org/en/blog/vulnerability/september-2016-security-releases/):
24+
* [CVE-2016-7099](https://nodejs.org/en/blog/vulnerability/september-2016-security-releases/):
2525
_Fix invalid wildcard certificate validation check_. This was a high-severity
2626
defect. It caused Node.js TLS clients to accept invalid wildcard certificates.
2727

28-
- [#5507](https://github.com/nodejs/node/pull/5507): _Fix a defect that makes
28+
* [#5507](https://github.com/nodejs/node/pull/5507): _Fix a defect that makes
2929
the CacheBleed Attack possible_. Many, though not all, OpenSSL vulnerabilities
3030
in the TLS/SSL protocols also affect Node.js.
3131

32-
- [CVE-2016-2216](https://nodejs.org/en/blog/vulnerability/february-2016-security-releases/):
32+
* [CVE-2016-2216](https://nodejs.org/en/blog/vulnerability/february-2016-security-releases/):
3333
_Fix defects in HTTP header parsing for requests and responses that can allow
3434
response splitting_. This was a remotely-exploitable defect in the Node.js
3535
HTTP implementation.

doc/api/addons.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ for more information on N-API.
1717
When not using N-API, implementing Addons is complicated,
1818
involving knowledge of several components and APIs:
1919

20-
- V8: the C++ library Node.js currently uses to provide the
20+
* V8: the C++ library Node.js currently uses to provide the
2121
JavaScript implementation. V8 provides the mechanisms for creating objects,
2222
calling functions, etc. V8's API is documented mostly in the
2323
`v8.h` header file (`deps/v8/include/v8.h` in the Node.js source
2424
tree), which is also available [online][v8-docs].
2525

26-
- [libuv][]: The C library that implements the Node.js event loop, its worker
26+
* [libuv][]: The C library that implements the Node.js event loop, its worker
2727
threads and all of the asynchronous behaviors of the platform. It also
2828
serves as a cross-platform abstraction library, giving easy, POSIX-like
2929
access across all major operating systems to many common system tasks, such
@@ -35,11 +35,11 @@ involving knowledge of several components and APIs:
3535
off-loading work via libuv to non-blocking system operations, worker threads
3636
or a custom use of libuv's threads.
3737

38-
- Internal Node.js libraries. Node.js itself exports a number of C++ APIs
38+
* Internal Node.js libraries. Node.js itself exports a number of C++ APIs
3939
that Addons can use &mdash; the most important of which is the
4040
`node::ObjectWrap` class.
4141

42-
- Node.js includes a number of other statically linked libraries including
42+
* Node.js includes a number of other statically linked libraries including
4343
OpenSSL. These other libraries are located in the `deps/` directory in the
4444
Node.js source tree. Only the libuv, OpenSSL, V8 and zlib symbols are
4545
purposefully re-exported by Node.js and may be used to various extents by
@@ -262,8 +262,8 @@ signature.
262262
In order to be loaded from multiple Node.js environments,
263263
such as a main thread and a Worker thread, an add-on needs to either:
264264
265-
- Be an N-API addon, or
266-
- Be declared as context-aware using `NODE_MODULE_INIT()` as described above
265+
* Be an N-API addon, or
266+
* Be declared as context-aware using `NODE_MODULE_INIT()` as described above
267267
268268
### Building
269269

doc/api/cli.md

+76-76
Original file line numberDiff line numberDiff line change
@@ -301,8 +301,8 @@ added: v11.4.0
301301

302302
Chooses an HTTP parser library. Available values are:
303303

304-
- `llhttp` for https://llhttp.org/
305-
- `legacy` for https://github.com/nodejs/http-parser
304+
* `llhttp` for https://llhttp.org/
305+
* `legacy` for https://github.com/nodejs/http-parser
306306

307307
The default is `llhttp`, unless otherwise specified when building Node.js.
308308

@@ -998,80 +998,80 @@ node --require "./a.js" --require "./b.js"
998998

999999
Node.js options that are allowed are:
10001000
<!-- node-options-node start -->
1001-
- `--enable-fips`
1002-
- `--es-module-specifier-resolution`
1003-
- `--experimental-exports`
1004-
- `--experimental-modules`
1005-
- `--experimental-policy`
1006-
- `--experimental-repl-await`
1007-
- `--experimental-report`
1008-
- `--experimental-vm-modules`
1009-
- `--experimental-wasm-modules`
1010-
- `--force-fips`
1011-
- `--frozen-intrinsics`
1012-
- `--heapsnapshot-signal`
1013-
- `--http-parser`
1014-
- `--http-server-default-timeout`
1015-
- `--icu-data-dir`
1016-
- `--input-type`
1017-
- `--inspect-brk`
1018-
- `--inspect-port`, `--debug-port`
1019-
- `--inspect-publish-uid`
1020-
- `--inspect`
1021-
- `--loader`
1022-
- `--max-http-header-size`
1023-
- `--napi-modules`
1024-
- `--no-deprecation`
1025-
- `--no-force-async-hooks-checks`
1026-
- `--no-warnings`
1027-
- `--openssl-config`
1028-
- `--pending-deprecation`
1029-
- `--policy-integrity`
1030-
- `--preserve-symlinks-main`
1031-
- `--preserve-symlinks`
1032-
- `--prof-process`
1033-
- `--redirect-warnings`
1034-
- `--report-directory`
1035-
- `--report-filename`
1036-
- `--report-on-fatalerror`
1037-
- `--report-on-signal`
1038-
- `--report-signal`
1039-
- `--report-uncaught-exception`
1040-
- `--require`, `-r`
1041-
- `--throw-deprecation`
1042-
- `--title`
1043-
- `--tls-cipher-list`
1044-
- `--tls-max-v1.2`
1045-
- `--tls-max-v1.3`
1046-
- `--tls-min-v1.0`
1047-
- `--tls-min-v1.1`
1048-
- `--tls-min-v1.2`
1049-
- `--tls-min-v1.3`
1050-
- `--trace-deprecation`
1051-
- `--trace-event-categories`
1052-
- `--trace-event-file-pattern`
1053-
- `--trace-events-enabled`
1054-
- `--trace-sync-io`
1055-
- `--trace-tls`
1056-
- `--trace-warnings`
1057-
- `--track-heap-objects`
1058-
- `--unhandled-rejections`
1059-
- `--use-bundled-ca`
1060-
- `--use-openssl-ca`
1061-
- `--v8-pool-size`
1062-
- `--zero-fill-buffers`
1001+
* `--enable-fips`
1002+
* `--es-module-specifier-resolution`
1003+
* `--experimental-exports`
1004+
* `--experimental-modules`
1005+
* `--experimental-policy`
1006+
* `--experimental-repl-await`
1007+
* `--experimental-report`
1008+
* `--experimental-vm-modules`
1009+
* `--experimental-wasm-modules`
1010+
* `--force-fips`
1011+
* `--frozen-intrinsics`
1012+
* `--heapsnapshot-signal`
1013+
* `--http-parser`
1014+
* `--http-server-default-timeout`
1015+
* `--icu-data-dir`
1016+
* `--input-type`
1017+
* `--inspect-brk`
1018+
* `--inspect-port`, `--debug-port`
1019+
* `--inspect-publish-uid`
1020+
* `--inspect`
1021+
* `--loader`
1022+
* `--max-http-header-size`
1023+
* `--napi-modules`
1024+
* `--no-deprecation`
1025+
* `--no-force-async-hooks-checks`
1026+
* `--no-warnings`
1027+
* `--openssl-config`
1028+
* `--pending-deprecation`
1029+
* `--policy-integrity`
1030+
* `--preserve-symlinks-main`
1031+
* `--preserve-symlinks`
1032+
* `--prof-process`
1033+
* `--redirect-warnings`
1034+
* `--report-directory`
1035+
* `--report-filename`
1036+
* `--report-on-fatalerror`
1037+
* `--report-on-signal`
1038+
* `--report-signal`
1039+
* `--report-uncaught-exception`
1040+
* `--require`, `-r`
1041+
* `--throw-deprecation`
1042+
* `--title`
1043+
* `--tls-cipher-list`
1044+
* `--tls-max-v1.2`
1045+
* `--tls-max-v1.3`
1046+
* `--tls-min-v1.0`
1047+
* `--tls-min-v1.1`
1048+
* `--tls-min-v1.2`
1049+
* `--tls-min-v1.3`
1050+
* `--trace-deprecation`
1051+
* `--trace-event-categories`
1052+
* `--trace-event-file-pattern`
1053+
* `--trace-events-enabled`
1054+
* `--trace-sync-io`
1055+
* `--trace-tls`
1056+
* `--trace-warnings`
1057+
* `--track-heap-objects`
1058+
* `--unhandled-rejections`
1059+
* `--use-bundled-ca`
1060+
* `--use-openssl-ca`
1061+
* `--v8-pool-size`
1062+
* `--zero-fill-buffers`
10631063
<!-- node-options-node end -->
10641064

10651065
V8 options that are allowed are:
10661066
<!-- node-options-v8 start -->
1067-
- `--abort-on-uncaught-exception`
1068-
- `--interpreted-frames-native-stack`
1069-
- `--max-old-space-size`
1070-
- `--perf-basic-prof-only-functions`
1071-
- `--perf-basic-prof`
1072-
- `--perf-prof-unwinding-info`
1073-
- `--perf-prof`
1074-
- `--stack-trace-limit`
1067+
* `--abort-on-uncaught-exception`
1068+
* `--interpreted-frames-native-stack`
1069+
* `--max-old-space-size`
1070+
* `--perf-basic-prof-only-functions`
1071+
* `--perf-basic-prof`
1072+
* `--perf-prof-unwinding-info`
1073+
* `--perf-prof`
1074+
* `--stack-trace-limit`
10751075
<!-- node-options-v8 end -->
10761076

10771077
### `NODE_PATH=path[:…]`
@@ -1206,12 +1206,12 @@ Asynchronous system APIs are used by Node.js whenever possible, but where they
12061206
do not exist, libuv's threadpool is used to create asynchronous node APIs based
12071207
on synchronous system APIs. Node.js APIs that use the threadpool are:
12081208

1209-
- all `fs` APIs, other than the file watcher APIs and those that are explicitly
1209+
* all `fs` APIs, other than the file watcher APIs and those that are explicitly
12101210
synchronous
1211-
- asynchronous crypto APIs such as `crypto.pbkdf2()`, `crypto.scrypt()`,
1211+
* asynchronous crypto APIs such as `crypto.pbkdf2()`, `crypto.scrypt()`,
12121212
`crypto.randomBytes()`, `crypto.randomFill()`, `crypto.generateKeyPair()`
1213-
- `dns.lookup()`
1214-
- all `zlib` APIs, other than those that are explicitly synchronous
1213+
* `dns.lookup()`
1214+
* all `zlib` APIs, other than those that are explicitly synchronous
12151215

12161216
Because libuv's threadpool has a fixed size, it means that if for whatever
12171217
reason any of these APIs takes a long time, other (seemingly unrelated) APIs

0 commit comments

Comments
 (0)