Skip to content

Commit

Permalink
doc: normalize shell code block info strings
Browse files Browse the repository at this point in the history
Prior to this commit, shell fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standarize on
the one with the highest frequency in the doc/api/ dir.

Stats:
> 'console' => 54,
> 'shell' => 2,

PR-URL: #33486
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
  • Loading branch information
Derek Lewis authored and codebytere committed Jun 18, 2020
1 parent 24ada7a commit 4cc391b
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ Primary GPG keys for Node.js Releasers (some Releasers sign with subkeys):

To import the full set of trusted release keys:

```shell
```bash
gpg --keyserver pool.sks-keyservers.net --recv-keys 4ED778F539E3634C779C87C6D7062848A1AB005C
gpg --keyserver pool.sks-keyservers.net --recv-keys 94AE36675C464D64BAFA68DD7434390BDBE9B9C5
gpg --keyserver pool.sks-keyservers.net --recv-keys 71DCFD284A79C3B38668286BC97EC7A07EDE3FC1
Expand Down
4 changes: 2 additions & 2 deletions doc/api/intl.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,13 +115,13 @@ through either:

* The [`NODE_ICU_DATA`][] environment variable:

```shell
```bash
env NODE_ICU_DATA=/some/directory node
```

* The [`--icu-data-dir`][] CLI parameter:

```shell
```bash
node --icu-data-dir=/some/directory
```

Expand Down
4 changes: 2 additions & 2 deletions doc/guides/backporting-to-release-lines.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ replace that with the staging branch for the targeted release line.
2. Make sure that the local staging branch is up to date with the remote.
3. Create a new branch off of the staging branch, as shown below.

```shell
```bash
# Assuming your fork of Node.js is checked out in $NODE_DIR,
# the origin remote points to your fork, and the upstream remote points
# to git://github.com/nodejs/node
Expand All @@ -55,7 +55,7 @@ replace that with the staging branch for the targeted release line.
will likely fail due to conflicts. In that case, you will see something
like this:

```shell
```console
# Say the $SHA is 773cdc31ef
$ git cherry-pick $SHA # Use your commit hash
error: could not apply 773cdc3... <commit title>
Expand Down
6 changes: 3 additions & 3 deletions doc/guides/maintaining-V8.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ that Node.js may be floating (or else cause a merge conflict).

The rough outline of the process is:

```shell
```bash
# Assuming your fork of Node.js is checked out in $NODE_DIR
# and you want to update the Node.js master branch.
# Find the current (OLD) version in
Expand Down Expand Up @@ -367,15 +367,15 @@ above. A better strategy is to

To audit for floating patches:

```shell
```bash
git log --oneline deps/v8
```

To replace the copy of V8 in Node.js, use the [`git-node`][] tool. For example,
if you want to replace the copy of V8 in Node.js with the branch-head for V8 5.1
branch:

```shell
```bash
cd $NODE_DIR
git node v8 major --branch=5.1-lkgr
```
Expand Down
18 changes: 9 additions & 9 deletions doc/guides/maintaining-icu.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ ICU consumes and includes:

The current versions of these items can be viewed for node with `node -p process.versions`:

```shell
```console
$ node -p process.versions

{
Expand Down Expand Up @@ -101,7 +101,7 @@ should be sufficient).
* Configure Node.js with the specific [ICU version](http://icu-project.org/download)
you want to upgrade to, for example:
```shell
```bash
./configure \
--with-intl=full-icu \
--with-icu-source=http://download.icu-project.org/files/icu4c/58.1/icu4c-58_1-src.tgz
Expand All @@ -118,7 +118,7 @@ make

* Verify the Node.js build works:

```shell
```bash
make test-ci
```

Expand All @@ -137,13 +137,13 @@ new Intl.DateTimeFormat('es', { month: 'long' }).format(new Date(9E8));
> :warning: Do not modify any source code in `deps/icu-small` !
> See section below about floating patches to ICU.
```shell
```bash
python tools/icu/shrink-icu-src.py
```

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

```shell
```bash
make -k distclean
./configure
make
Expand All @@ -168,7 +168,7 @@ so make this a separate commit from the smaller changes.
* Now, rebuild the Node.js license.

```shell
```bash
# clean up - remove deps/icu
make clean
tools/license-builder.sh
Expand All @@ -178,7 +178,7 @@ tools/license-builder.sh
It should match the ICU URL used in the first step. When this is done, the
following should build with small ICU.

```shell
```bash
# clean up
rm -rf out deps/icu deps/icu4c*
./configure --with-intl=small-icu --download=all
Expand Down Expand Up @@ -210,7 +210,7 @@ version.
For example, to patch `source/tools/toolutil/pkg_genc.cpp` for
ICU version 63:

```shell
```bash
# go to your Node.js source directory
cd <node>

Expand All @@ -233,7 +233,7 @@ make clean && ./configure && make

You should see a message such as:

```shell
```console
INFO: Using floating patch "tools/icu/patches/63/source/tools/toolutil/pkg_genc.cpp" from "tools/icu"
```

Expand Down
6 changes: 3 additions & 3 deletions doc/guides/maintaining-root-certs.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ the nodejs/node repository.

Update the tag in the commands below, and run:

```shell
```bash
cd tools/
./mk-ca-bundle.pl -v 2>_before
curl -O https://hg.mozilla.org/projects/nss/raw-file/NSS_3_41_RTM/lib/ckfw/builtins/certdata.txt
Expand All @@ -57,15 +57,15 @@ the nodejs/node repository.

Run the command below:

```shell
```bash
./mk-ca-bundle.pl -v 2>_after
```

Confirm that `../src/node_root_certs.h` was updated.

Determine what changes were made by diffing the before and after files:

```shell
```console
% diff _before _after
11d10
< Parsing: Visa eCommerce Root
Expand Down
2 changes: 1 addition & 1 deletion doc/guides/maintaining-zlib.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ performance improvements not currently available in standard zlib.
## Updating zlib

Update zlib:
```shell
```bash
git clone https://chromium.googlesource.com/chromium/src/third_party/zlib
cp deps/zlib/zlib.gyp deps/zlib/win32/zlib.def deps
rm -rf deps/zlib zlib/.git
Expand Down

0 comments on commit 4cc391b

Please sign in to comment.