FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: normalize Bash code block info strings · nodejs/node@cf82adf · GitHub

/ node Public

Commit cf82adf

Browse files
Derek Lewis
authored and
codebytere
committed
doc: normalize Bash code block info strings
Prior to this commit, Bash fenced code blocks in Markdown files had inconsistent info strings. This has been corrected to standardize on the less-obscure variant. PR-URL: #33510 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent 18dc03d commit cf82adf

11 files changed

Lines changed: 25 additions & 25 deletions

File tree

‎doc/api/deprecations.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1577,7 +1577,7 @@ querystring.parse(str, '\n', '=');
15771577
This function is not completely equivalent to `querystring.parse()`. One
15781578
difference is that `querystring.parse()` does url decoding:
15791579

1580-
```sh
1580+
```console
15811581
> querystring.parse('%E5%A5%BD=1', '\n', '=');
15821582
{ '好': '1' }
15831583
> tls.parseCertString('%E5%A5%BD=1');

‎doc/api/esm.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ until the root of the volume is reached.
9494
}
9595
```
9696

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

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

190190
echo "import { sep } from 'path'; console.log(sep);" | node --input-type=module

‎doc/api/modules.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -680,7 +680,7 @@ In `entry.js` script:
680680
console.log(require.main);
681681
```
682682

683-
```sh
683+
```bash
684684
node entry.js
685685
```
686686

‎doc/api/policy.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ when loading modules.
3131
Once this has been set, all modules must conform to a policy manifest file
3232
passed to the flag:
3333

34-
```sh
34+
```bash
3535
node --experimental-policy=policy.json app.js
3636
```
3737

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

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

‎doc/api/tls.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Private keys can be generated in multiple ways. The example below illustrates
2121
use of the OpenSSL command-line interface to generate a 2048-bit RSA private
2222
key:
2323

24-
```sh
24+
```bash
2525
openssl genrsa -out ryans-key.pem 2048
2626
```
2727

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

38-
```sh
38+
```bash
3939
openssl req -new -sha256 -key ryans-key.pem -out ryans-csr.pem
4040
```
4141

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

48-
```sh
48+
```bash
4949
openssl x509 -req -in ryans-csr.pem -signkey ryans-key.pem -out ryans-cert.pem
5050
```
5151

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

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

98-
```sh
98+
```bash
9999
openssl dhparam -outform PEM -out dhparam.pem 2048
100100
```
101101

@@ -254,7 +254,7 @@ failures, it is easy to not notice unnecessarily poor TLS performance. The
254254
OpenSSL CLI can be used to verify that servers are resuming sessions. Use the
255255
`-reconnect` option to `openssl s_client`, for example:
256256

257-
```sh
257+
```console
258258
$ openssl s_client -connect localhost:443 -reconnect
259259
```
260260

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

311-
```sh
311+
```bash
312312
node --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4" server.js
313313

314314
export NODE_OPTIONS=--tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4"

‎doc/api/tty.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ default be instances of `tty.WriteStream`. The preferred method of determining
1919
whether Node.js is being run within a TTY context is to check that the value of
2020
the `process.stdout.isTTY` property is `true`:
2121

22-
```sh
22+
```console
2323
$ node -p -e "Boolean(process.stdout.isTTY)"
2424
true
2525
$ node -p -e "Boolean(process.stdout.isTTY)" | cat

‎doc/guides/collaborator-guide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -638,7 +638,7 @@ That means a commit has landed since your last rebase against `upstream/master`.
638638
To fix this, pull with rebase from upstream, run the tests again, and (if the
639639
tests pass) push again:
640640

641-
```sh
641+
```bash
642642
git pull upstream master --rebase
643643
make -j4 test
644644
git push upstream master

‎doc/guides/maintaining-openssl.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This document describes how to update `deps/openssl/`.
1010

1111
## 0. Check Requirements
1212

13-
```sh
13+
```console
1414
% perl -v
1515

1616
This is perl 5, version 22, subversion 1 (v5.22.1) built for
@@ -30,7 +30,7 @@ NASM version 2.11.08
3030
Get a new source from <https://www.openssl.org/source/> and extract
3131
all files into `deps/openssl/openssl`. Then add all files and commit
3232
them.
33-
```sh
33+
```console
3434
% cd deps/openssl/
3535
% rm -rf openssl
3636
% tar zxf ~/tmp/openssl-1.1.0h.tar.gz
@@ -57,7 +57,7 @@ This updates all sources in deps/openssl/openssl by:
5757

5858
Use `make` to regenerate all platform dependent files in
5959
`deps/openssl/config/archs/`:
60-
```sh
60+
```console
6161
% make -C deps/openssl/config
6262
```
6363

@@ -66,7 +66,7 @@ Use `make` to regenerate all platform dependent files in
6666
Check diffs to ensure updates are right. Even if there are no updates in openssl
6767
sources, `buildinf.h` files will be updated because they have timestamp
6868
data in them.
69-
```sh
69+
```console
7070
% git diff -- deps/openssl
7171
```
7272

@@ -81,7 +81,7 @@ please ask @shigeki for details.
8181

8282
Update all architecture dependent files. Do not forget to git add or remove
8383
files if they are changed before committing:
84-
```sh
84+
```console
8585
% git add deps/openssl/config/archs
8686
% git add deps/openssl/openssl/include/crypto/bn_conf.h
8787
% git add deps/openssl/openssl/include/crypto/dso_conf.h

‎doc/guides/onboarding-extras.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ request.
3737
* A breaking change helper
3838
([full source](https://gist.github.com/chrisdickinson/ba532fa0e4e243fb7b44)):
3939

40-
```sh
40+
```bash
4141
SHOW=$(git show-ref -d $(git describe --abbrev=0) | tail -n1 | awk '{print $1}')
4242
git checkout $(git show -s --pretty='%T' $SHOW) -- test
4343
make -j4 test

‎doc/guides/releases.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -576,22 +576,22 @@ same GPG key!**
576576
Use `tools/release.sh` to promote and sign the build. Before doing this, you'll
577577
need to ensure you've loaded the correct ssh key, or you'll see the following:
578578

579-
```sh
579+
```console
580580
# Checking for releases ...
581581
Enter passphrase for key '/Users/<user>/.ssh/id_rsa':
582582
dist@direct.nodejs.org's password:
583583
```
584584

585585
The key can be loaded either with `ssh-add`:
586586

587-
```sh
587+
```console
588588
# Substitute node_id_rsa with whatever you've named the key
589589
$ ssh-add ~/.ssh/node_id_rsa
590590
```
591591

592592
or at runtime with:
593593

594-
```sh
594+
```console
595595
# Substitute node_id_rsa with whatever you've named the key
596596
$ ./tools/release.sh -i ~/.ssh/node_id_rsa
597597
```

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL