Skip to content

Commit

Permalink
doc: update list style in misc README docs
Browse files Browse the repository at this point in the history
To confirm with upcoming markdown lint rule, use `*` for unordered
lists.

PR-URL: #29594
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information
Trott authored and BridgeAR committed Sep 25, 2019
1 parent 38028ef commit 0074c8a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 23 deletions.
6 changes: 3 additions & 3 deletions test/wpt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,9 @@ It also maintains the LICENSE file in `test/fixtures/wpt`.
Given a module, the `WPTRunner` class in [`test/common/wpt`](../common/wpt.js)
loads:

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

Then, for each test, it creates a vm with the globals and mocks,
sets up the harness result hooks, loads the metadata in the test (including
Expand Down
40 changes: 20 additions & 20 deletions tools/icu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@ This directory contains tools, data, and information about the [ICU](http://icu-
(International Components for Unicode) integration. ICU is used to provide
internationalization functionality.

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

## How to upgrade ICU

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

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

- Verify the Node.js build works:
* Verify the Node.js build works:

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

…Should return `January` not `enero`.

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

```shell
python tools/icu/shrink-icu-src.py
```

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

```shell
make -k distclean
./configure
make
```

- Test this newly default-generated Node.js
* Test this newly default-generated Node.js

<!-- eslint-disable strict -->

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

- Now, rebuild the Node.js license.
* Now, rebuild the Node.js license.

```shell
# clean up - remove deps/icu
make clean
tools/license-builder.sh
```

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

Expand All @@ -104,9 +104,9 @@ make
make test-ci
```

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

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

0 comments on commit 0074c8a

Please sign in to comment.