From 0f432dfc5e67e690cabfda23ba11be5514c697a8 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 30 Aug 2019 00:10:19 -0400 Subject: [PATCH] doc: escape elements swallowed as HTML in markdown Addresses Markdownlint MD033 issues. Altering changlog should usually be avoided, but they don't render currently. --- COLLABORATOR_GUIDE.md | 2 +- doc/api/tls.md | 9 +++++---- doc/changelogs/CHANGELOG_IOJS.md | 6 +++--- doc/changelogs/CHANGELOG_V4.md | 2 +- doc/changelogs/CHANGELOG_V6.md | 2 +- 5 files changed, 11 insertions(+), 10 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 93e6522e0402b9..d8e0d22fd8f705 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -587,7 +587,7 @@ $ git push upstream master Close the pull request with a "Landed in ``" comment. If your pull request shows the purple merged status then you should still -add the "Landed in .." comment if you added +add the "Landed in \..\" comment if you added more than one commit. ### Troubleshooting diff --git a/doc/api/tls.md b/doc/api/tls.md index 5b797b35a33750..5b276a5f811f4d 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -1431,10 +1431,11 @@ changes: PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with `options.passphrase`. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or - buffers, or an array of objects in the form `{pem: [, - passphrase: ]}`. The object form can only occur in an array. - `object.passphrase` is optional. Encrypted keys will be decrypted with - `object.passphrase` if provided, or `options.passphrase` if it is not. + buffers, or an array of objects in the form + `{pem: [, passphrase: ]}`. The object form can only + occur in an array. `object.passphrase` is optional. Encrypted keys will be + decrypted with `object.passphrase` if provided, or `options.passphrase` if + it is not. * `maxVersion` {string} Optionally set the maximum TLS version to allow. One of `TLSv1.3`, `TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the `secureProtocol` option, use one or the other. diff --git a/doc/changelogs/CHANGELOG_IOJS.md b/doc/changelogs/CHANGELOG_IOJS.md index 7e5d9f54f16ad9..a3ba411cefaad4 100644 --- a/doc/changelogs/CHANGELOG_IOJS.md +++ b/doc/changelogs/CHANGELOG_IOJS.md @@ -446,8 +446,8 @@ See https://github.com/nodejs/node/labels/confirmed-bug for complete and current * [[`b625ab4242`](https://github.com/nodejs/node/commit/b625ab4242)] - **buffer**: fix usage of kMaxLength (Trevor Norris) [#2003](https://github.com/nodejs/node/pull/2003) * [[`eea66e2a7b`](https://github.com/nodejs/node/commit/eea66e2a7b)] - **(SEMVER-MAJOR)** **buffer**: fix case of one buffer passed to concat (Sakthipriyan Vairamani) [#1937](https://github.com/nodejs/node/pull/1937) * [[`8664084166`](https://github.com/nodejs/node/commit/8664084166)] - **buffer**: make additional changes to native API (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) -* [[`36f78f4c1c`](https://github.com/nodejs/node/commit/36f78f4c1c)] - **buffer**: switch API to return MaybeLocal (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) -* [[`571ec13841`](https://github.com/nodejs/node/commit/571ec13841)] - **buffer**: switch to using Maybe API (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) +* [[`36f78f4c1c`](https://github.com/nodejs/node/commit/36f78f4c1c)] - **buffer**: switch API to return MaybeLocal\ (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) +* [[`571ec13841`](https://github.com/nodejs/node/commit/571ec13841)] - **buffer**: switch to using Maybe\ API (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) * [[`d75f5c8d0e`](https://github.com/nodejs/node/commit/d75f5c8d0e)] - **buffer**: finish implementing FreeCallback (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) * [[`63da0dfd3a`](https://github.com/nodejs/node/commit/63da0dfd3a)] - **buffer**: implement Uint8Array backed Buffer (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) * [[`23be6ca189`](https://github.com/nodejs/node/commit/23be6ca189)] - **buffer**: allow ARGS_THIS to accept a name (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) @@ -1739,7 +1739,7 @@ will be removed at a later point. (Roman Reiss) [#1363](https://github.com/nodej * [[`bc9c1a5a7b`](https://github.com/nodejs/node/commit/bc9c1a5a7b)] - **doc**: fix typo in CHANGELOG (Mathieu Darse) [#1230](https://github.com/nodejs/node/pull/1230) * [[`99c79f8d41`](https://github.com/nodejs/node/commit/99c79f8d41)] - **doc**: call js function in null context (Ben Noordhuis) [#1125](https://github.com/nodejs/node/pull/1125) * [[`55abf34be5`](https://github.com/nodejs/node/commit/55abf34be5)] - **doc**: don't use `using namespace v8` (Ben Noordhuis) [#1125](https://github.com/nodejs/node/pull/1125) -* [[`c4e1b82120`](https://github.com/nodejs/node/commit/c4e1b82120)] - **doc**: replace v8::Handle with v8::Local (Ben Noordhuis) [#1125](https://github.com/nodejs/node/pull/1125) +* [[`c4e1b82120`](https://github.com/nodejs/node/commit/c4e1b82120)] - **doc**: replace v8::Handle\ with v8::Local\ (Ben Noordhuis) [#1125](https://github.com/nodejs/node/pull/1125) * [[`2f1b78347c`](https://github.com/nodejs/node/commit/2f1b78347c)] - **doc**: remove unnecessary v8::HandleScopes (Ben Noordhuis) [#1125](https://github.com/nodejs/node/pull/1125) * [[`409d413363`](https://github.com/nodejs/node/commit/409d413363)] - **doc**: remove uses of v8::Isolate::GetCurrent() (Ben Noordhuis) [#1125](https://github.com/nodejs/node/pull/1125) * [[`33fea6ed5f`](https://github.com/nodejs/node/commit/33fea6ed5f)] - **lib**: don't penalize setInterval() common case (Ben Noordhuis) [#1221](https://github.com/nodejs/node/pull/1221) diff --git a/doc/changelogs/CHANGELOG_V4.md b/doc/changelogs/CHANGELOG_V4.md index 9ec422f98f6703..e9c373ac73ac92 100644 --- a/doc/changelogs/CHANGELOG_V4.md +++ b/doc/changelogs/CHANGELOG_V4.md @@ -1273,7 +1273,7 @@ Semver Patch: * [[`3ff82deb2c`](https://github.com/nodejs/node/commit/3ff82deb2c)] - **lib**: make tls.checkServerIdentity() more strict (Ben Noordhuis) [nodejs/node-private#63](https://github.com/nodejs/node-private/pull/63) * [[`7c696e201a`](https://github.com/nodejs/node/commit/7c696e201a)] - **openssl**: fix keypress requirement in apps on win32 (Shigeki Ohtsu) [nodejs/node#1389](https://github.com/nodejs/node/pull/1389) * [[`44e5776c0f`](https://github.com/nodejs/node/commit/44e5776c0f)] - **openssl**: fix keypress requirement in apps on win32 (Shigeki Ohtsu) [nodejs/node#1389](https://github.com/nodejs/node/pull/1389) -* [[`c7a601c090`](https://github.com/nodejs/node/commit/c7a601c090)] - **test**: remove openssl options of -no_ (Shigeki Ohtsu) [#8714](https://github.com/nodejs/node/pull/8714) +* [[`c7a601c090`](https://github.com/nodejs/node/commit/c7a601c090)] - **test**: remove openssl options of -no_\ (Shigeki Ohtsu) [#8714](https://github.com/nodejs/node/pull/8714) ## 2016-08-15, Version 4.5.0 'Argon' (LTS), @thealphanerd diff --git a/doc/changelogs/CHANGELOG_V6.md b/doc/changelogs/CHANGELOG_V6.md index fa03a281deeeb1..e16f14cd24c55b 100644 --- a/doc/changelogs/CHANGELOG_V6.md +++ b/doc/changelogs/CHANGELOG_V6.md @@ -3650,7 +3650,7 @@ Semver Patch: * [[`38bed98a92`](https://github.com/nodejs/node/commit/38bed98a92)] - **openssl**: fix keypress requirement in apps on win32 (Shigeki Ohtsu) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`a25fc3f715`](https://github.com/nodejs/node/commit/a25fc3f715)] - **openssl**: fix keypress requirement in apps on win32 (Shigeki Ohtsu) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`5902ba3989`](https://github.com/nodejs/node/commit/5902ba3989)] - **src**: Malloc/Calloc size 0 returns non-null pointer (Rich Trott) [#8572](https://github.com/nodejs/node/pull/8572) -* [[`a14d832884`](https://github.com/nodejs/node/commit/a14d832884)] - **test**: remove openssl options of -no_ (Shigeki Ohtsu) [#8714](https://github.com/nodejs/node/pull/8714) +* [[`a14d832884`](https://github.com/nodejs/node/commit/a14d832884)] - **test**: remove openssl options of -no_\ (Shigeki Ohtsu) [#8714](https://github.com/nodejs/node/pull/8714) ## 2016-09-14, Version 6.6.0 (Current), @Fishrock123