Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: replace bash references with sh #34869

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ loopback interface must also have '::1' enabled. For some default installations
on Ubuntu that does not seem to be the case. To enable '::1' on the
loopback interface on Ubuntu:

```bash
```sh
sudo sysctl -w net.ipv6.conf.lo.disable_ipv6=0
```

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -594,7 +594,7 @@ Primary GPG keys for Node.js Releasers (some Releasers sign with subkeys):

To import the full set of trusted release keys:

```bash
```sh
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
6 changes: 3 additions & 3 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -1223,14 +1223,14 @@ script file.
In case an option value happens to contain a space (for example a path listed
in `--require`), it must be escaped using double quotes. For example:

```bash
```sh
NODE_OPTIONS='--require "./my path/file.js"'
```

A singleton flag passed as a command line option will override the same flag
passed into `NODE_OPTIONS`:

```bash
```sh
# The inspector will be available on port 5555
NODE_OPTIONS='--inspect=localhost:4444' node --inspect=localhost:5555
```
Expand All @@ -1239,7 +1239,7 @@ A flag that can be passed multiple times will be treated as if its
`NODE_OPTIONS` instances were passed first, and then its command line
instances afterwards:

```bash
```sh
NODE_OPTIONS='--require "./a.js"' node --require "./b.js"
# is equivalent to:
node --require "./a.js" --require "./b.js"
Expand Down
14 changes: 7 additions & 7 deletions doc/api/esm.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ until the root of the volume is reached.
}
```

```bash
```sh
# In same folder as above package.json
node my-app.js # Runs as ES module
```
Expand Down Expand Up @@ -184,7 +184,7 @@ Strings passed in as an argument to `--eval` (or `-e`), or piped to `node` via
`STDIN`, will be treated as ES modules when the `--input-type=module` flag is
set.

```bash
```sh
node --input-type=module --eval "import { sep } from 'path'; console.log(sep);"

echo "import { sep } from 'path'; console.log(sep);" | node --input-type=module
Expand Down Expand Up @@ -506,7 +506,7 @@ conditions behave analogously to nested JavaScript `if` statements.
When running Node.js, custom user conditions can be added with the
`--conditions` or `-u` flag:

```bash
```sh
node --conditions=development main.js
```

Expand Down Expand Up @@ -1130,7 +1130,7 @@ import packageConfig from './package.json';
The `--experimental-json-modules` flag is needed for the module
to work.

```bash
```sh
node index.mjs # fails
node --experimental-json-modules index.mjs # works
```
Expand All @@ -1153,7 +1153,7 @@ console.log(M);

executed under:

```bash
```sh
node --experimental-wasm-modules index.mjs
```

Expand All @@ -1179,7 +1179,7 @@ import { five } from './a.mjs';
console.log(five); // Logs `5`
```

```bash
```sh
node b.mjs # works
```

Expand Down Expand Up @@ -1506,7 +1506,7 @@ console.log(VERSION);

With this loader, running:

```bash
```sh
node --experimental-loader ./https-loader.mjs ./main.mjs
```

Expand Down
2 changes: 1 addition & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3732,7 +3732,7 @@ fs.symlink('./mew', './example/mewtwo', callback);
The above example creates a symbolic link `mewtwo` in the `example` which points
to `mew` in the same directory:

```bash
```console
$ tree example/
example/
├── mew
Expand Down
2 changes: 1 addition & 1 deletion doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ server.listen(8443);

To generate the certificate and key for this example, run:

```bash
```sh
openssl req -x509 -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost' \
-keyout localhost-privkey.pem -out localhost-cert.pem
```
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:

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion doc/api/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -689,7 +689,7 @@ In `entry.js` script:
console.log(require.main);
```

```bash
```sh
node entry.js
```

Expand Down
4 changes: 2 additions & 2 deletions doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,15 +134,15 @@ For Mac developers, [Xcode][] offers all the required compiler tools.
However, it is not necessary to install the entire Xcode IDE. The following
command installs the necessary toolchain:

```bash
```sh
xcode-select --install
```

For Windows developers, [Visual Studio][] offers all the required compiler
tools. However, it is not necessary to install the entire Visual Studio
IDE. The following command installs the necessary toolchain:

```bash
```sh
npm install --global --production windows-build-tools
```

Expand Down
4 changes: 2 additions & 2 deletions doc/api/policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ when loading modules.
Once this has been set, all modules must conform to a policy manifest file
passed to the flag:

```bash
```sh
node --experimental-policy=policy.json app.js
```

Expand All @@ -43,7 +43,7 @@ the policy file itself may be provided via `--policy-integrity`.
This allows running `node` and asserting the policy file contents
even if the file is changed on disk.

```bash
```sh
node --experimental-policy=policy.json --policy-integrity="sha384-SggXRQHwCG8g+DktYYzxkXRIkTiEYWBHqev0xnpCxYlqMBufKZHAHQM3/boDaI/0" app.js
```

Expand Down
4 changes: 2 additions & 2 deletions doc/api/report.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ is provided below for reference.

## Usage

```bash
```sh
node --report-uncaught-exception --report-on-signal \
--report-on-fatalerror app.js
```
Expand Down Expand Up @@ -567,7 +567,7 @@ process.report.signal = 'SIGQUIT';
Configuration on module initialization is also available via
environment variables:

```bash
```sh
NODE_OPTIONS="--report-uncaught-exception \
--report-on-fatalerror --report-on-signal \
--report-signal=SIGUSR2 --report-filename=./report.json \
Expand Down
12 changes: 6 additions & 6 deletions doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Private keys can be generated in multiple ways. The example below illustrates
use of the OpenSSL command-line interface to generate a 2048-bit RSA private
key:

```bash
```sh
openssl genrsa -out ryans-key.pem 2048
```

Expand All @@ -37,7 +37,7 @@ step to obtaining a certificate is to create a *Certificate Signing Request*
The OpenSSL command-line interface can be used to generate a CSR for a private
key:

```bash
```sh
openssl req -new -sha256 -key ryans-key.pem -out ryans-csr.pem
```

Expand All @@ -47,14 +47,14 @@ Authority for signing or used to generate a self-signed certificate.
Creating a self-signed certificate using the OpenSSL command-line interface
is illustrated in the example below:

```bash
```sh
openssl x509 -req -in ryans-csr.pem -signkey ryans-key.pem -out ryans-cert.pem
```

Once the certificate is generated, it can be used to generate a `.pfx` or
`.p12` file:

```bash
```sh
openssl pkcs12 -export -in ryans-cert.pem -inkey ryans-key.pem \
-certfile ca-cert.pem -out ryans.pfx
```
Expand Down Expand Up @@ -97,7 +97,7 @@ to generate Diffie-Hellman parameters and specify them with the `dhparam`
option to [`tls.createSecureContext()`][]. The following illustrates the use of
the OpenSSL command-line interface to generate such parameters:

```bash
```sh
openssl dhparam -outform PEM -out dhparam.pem 2048
```

Expand Down Expand Up @@ -313,7 +313,7 @@ line switch (directly, or via the [`NODE_OPTIONS`][] environment variable). For
instance, the following makes `ECDHE-RSA-AES128-GCM-SHA256:!RC4` the default TLS
cipher suite:

```bash
```sh
node --tls-cipher-list='ECDHE-RSA-AES128-GCM-SHA256:!RC4' server.js

export NODE_OPTIONS=--tls-cipher-list='ECDHE-RSA-AES128-GCM-SHA256:!RC4'
Expand Down
6 changes: 3 additions & 3 deletions doc/api/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The available categories are:

By default the `node`, `node.async_hooks`, and `v8` categories are enabled.

```bash
```sh
node --trace-event-categories v8,node,node.async_hooks server.js
```

Expand All @@ -47,7 +47,7 @@ flag to enable trace events. This requirement has been removed. However, the
`--trace-events-enabled` flag *may* still be used and will enable the
`node`, `node.async_hooks`, and `v8` trace event categories by default.

```bash
```sh
node --trace-events-enabled

# is equivalent to
Expand Down Expand Up @@ -76,7 +76,7 @@ The logging file is by default called `node_trace.${rotation}.log`, where
be specified with `--trace-event-file-pattern` that accepts a template
string that supports `${rotation}` and `${pid}`:

```bash
```sh
node --trace-event-categories v8 --trace-event-file-pattern '${pid}-${rotation}.log' server.js
```

Expand Down
2 changes: 1 addition & 1 deletion 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.

```bash
```sh
# 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 Down
4 changes: 2 additions & 2 deletions doc/guides/building-node-with-ninja.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ compile much faster than even `make -j4` (or
number of processes to run for [Ninja][] using the environment variable `JOBS`.
This will be the equivalent to the `-j` parameter in the regular `make`:

```bash
```sh
JOBS=12 make
```

## Producing a debug build

To create a debug build rather than a release build:

```bash
```sh
./configure --ninja --debug && make
```

Expand Down
2 changes: 1 addition & 1 deletion doc/guides/collaborator-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,7 @@ That means a commit has landed since your last rebase against `upstream/master`.
To fix this, pull with rebase from upstream, run the tests again, and (if the
tests pass) push again:

```bash
```sh
git pull upstream master --rebase
make -j4 test
git push upstream master
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:

```bash
```sh
# 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:

```bash
```sh
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:

```bash
```sh
cd $NODE_DIR
git node v8 major --branch=5.1-lkgr
```
Expand Down
Loading