Skip to content

Commit 0074c8a

Browse files
TrottBridgeAR
authored andcommitted
doc: update list style in misc README docs
To confirm with upcoming markdown lint rule, use `*` for unordered lists. PR-URL: #29594 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent 38028ef commit 0074c8a

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

test/wpt/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,9 @@ It also maintains the LICENSE file in `test/fixtures/wpt`.
134134
Given a module, the `WPTRunner` class in [`test/common/wpt`](../common/wpt.js)
135135
loads:
136136

137-
- `.js` test files (for example, `test/common/wpt/url/*.js` for `url`)
138-
- Status file (for example, `test/wpt/status/url.json` for `url`)
139-
- The WPT harness
137+
* `.js` test files (for example, `test/common/wpt/url/*.js` for `url`)
138+
* Status file (for example, `test/wpt/status/url.json` for `url`)
139+
* The WPT harness
140140

141141
Then, for each test, it creates a vm with the globals and mocks,
142142
sets up the harness result hooks, loads the metadata in the test (including

tools/icu/README.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@ This directory contains tools, data, and information about the [ICU](http://icu-
44
(International Components for Unicode) integration. ICU is used to provide
55
internationalization functionality.
66

7-
- `patches/` are one-off patches, actually entire source file replacements,
7+
* `patches/` are one-off patches, actually entire source file replacements,
88
organized by ICU version number.
9-
- `icu_small.json` controls the "small" (English only) ICU. It is input to
9+
* `icu_small.json` controls the "small" (English only) ICU. It is input to
1010
`icutrim.py`
11-
- `icu-generic.gyp` is the build file used for most ICU builds within ICU.
11+
* `icu-generic.gyp` is the build file used for most ICU builds within ICU.
1212
<!-- have fun -->
13-
- `icu-system.gyp` is an alternate build file used when `--with-intl=system-icu`
13+
* `icu-system.gyp` is an alternate build file used when `--with-intl=system-icu`
1414
is invoked. It builds against the `pkg-config` located ICU.
15-
- `iculslocs.cc` is source for the `iculslocs` utility, invoked by `icutrim.py`
15+
* `iculslocs.cc` is source for the `iculslocs` utility, invoked by `icutrim.py`
1616
as part of repackaging. Not used separately. See source for more details.
17-
- `no-op.cc` — empty function to convince gyp to use a C++ compiler.
18-
- `README.md` — you are here
19-
- `shrink-icu-src.py` — this is used during upgrade (see guide below)
17+
* `no-op.cc` — empty function to convince gyp to use a C++ compiler.
18+
* `README.md` — you are here
19+
* `shrink-icu-src.py` — this is used during upgrade (see guide below)
2020

2121
## How to upgrade ICU
2222

23-
- Make sure your Node.js workspace is clean (clean `git status`) should be
23+
* Make sure your Node.js workspace is clean (clean `git status`) should be
2424
sufficient.
25-
- Configure Node.js with the specific [ICU version](http://icu-project.org/download)
25+
* Configure Node.js with the specific [ICU version](http://icu-project.org/download)
2626
you want to upgrade to, for example:
2727

2828
```shell
@@ -35,12 +35,12 @@ make
3535
> _Note_ in theory, the equivalent `vcbuild.bat` commands should work also,
3636
> but the commands below are makefile-centric.
3737
38-
- If there are ICU version-specific changes needed, you may need to make changes
38+
* If there are ICU version-specific changes needed, you may need to make changes
3939
in `icu-generic.gyp` or add patch files to `tools/icu/patches`.
40-
- Specifically, look for the lists in `sources!` in the `icu-generic.gyp` for
40+
* Specifically, look for the lists in `sources!` in the `icu-generic.gyp` for
4141
files to exclude.
4242

43-
- Verify the Node.js build works:
43+
* Verify the Node.js build works:
4444

4545
```shell
4646
make test-ci
@@ -56,21 +56,21 @@ new Intl.DateTimeFormat('es', {month: 'long'}).format(new Date(9E8));
5656

5757
…Should return `January` not `enero`.
5858

59-
- Now, copy `deps/icu` over to `deps/icu-small`
59+
* Now, copy `deps/icu` over to `deps/icu-small`
6060

6161
```shell
6262
python tools/icu/shrink-icu-src.py
6363
```
6464

65-
- Now, do a clean rebuild of Node.js to test:
65+
* Now, do a clean rebuild of Node.js to test:
6666

6767
```shell
6868
make -k distclean
6969
./configure
7070
make
7171
```
7272

73-
- Test this newly default-generated Node.js
73+
* Test this newly default-generated Node.js
7474

7575
<!-- eslint-disable strict -->
7676

@@ -84,15 +84,15 @@ new Intl.DateTimeFormat('es', {month: 'long'}).format(new Date(9E8));
8484
You are ready to check in the updated `deps/small-icu`. This is a big commit,
8585
so make this a separate commit from the smaller changes.
8686

87-
- Now, rebuild the Node.js license.
87+
* Now, rebuild the Node.js license.
8888

8989
```shell
9090
# clean up - remove deps/icu
9191
make clean
9292
tools/license-builder.sh
9393
```
9494

95-
- Update the URL and hash for the full ICU file in `tools/icu/current_ver.dep`.
95+
* Update the URL and hash for the full ICU file in `tools/icu/current_ver.dep`.
9696
It should match the ICU URL used in the first step. When this is done, the
9797
following should build with full ICU.
9898

@@ -104,9 +104,9 @@ make
104104
make test-ci
105105
```
106106

107-
- commit the change to `tools/icu/current_ver.dep` and `LICENSE` files.
107+
* commit the change to `tools/icu/current_ver.dep` and `LICENSE` files.
108108

109-
- Note: To simplify review, I often will “pre-land” this patch, meaning that
109+
* Note: To simplify review, I often will “pre-land” this patch, meaning that
110110
I run the patch through `curl -L https://github.com/nodejs/node/pull/xxx.patch
111111
| git am -3 --whitespace=fix` per the collaborator’s guide… and then push that
112112
patched branch into my PR's branch. This reduces the whitespace changes that

0 commit comments

Comments
 (0)