0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 23:16:30 +01:00
nodejs/doc
willhayslett a43e8896f2 doc, src: sort + fill up cli options and env vars
* Alphabetize the command line options and environment
  variables in doc/api/cli.md for consistency and readability.

* Update doc/api/cli.md to include command line options
  being printed in the `node.PrintHelp()` function in src/node.cc
  but weren't otherwise documented in the cli spec. Options added
  include:

  --napi-modules
  --v8-pool-size=num
  --experimental-modules
  --experimental-vm-modules

* ASCII sort the node man page command line options.
  This change brings sort order consistency between the
  cli options displayed in doc/node.1 and the cli options
  enumerated in other areas of the project.

  Also rearrange the language for `--use-bundled-ca`, `--use-openssl-ca`
  to correspond with the order of the options as displayed.

* Update `node.PrintHelp()` function to return command line options
  and environment variables sorted in ASCII order. Additionally,
  add missing options as sourced from doc/api/cli.md. Options
  added include `--`, `--help` and the `NODE_PRESERVE_SYMLINKS`
  environment variable.

  Also update the comments in the `node.PrintHelp()` method
  to C++ style.

* Create tests to validate that the newly ASCII sorted
  cli options in the `node.PrintHelp()` function are being
  returned according to build configurations as expected.

PR-URL: https://github.com/nodejs/node/pull/19878
Refs: https://github.com/nodejs/node/issues/19814
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-04-13 23:14:54 +03:00
..
api doc, src: sort + fill up cli options and env vars 2018-04-13 23:14:54 +03:00
api_assets doc: fix paragraph line-height issue 2017-10-15 12:39:49 +02:00
changelogs 2018-04-05, Version 9.11.1 (Current) 2018-04-05 01:20:09 -04:00
guides doc: added missing reference to test coverage info 2018-04-06 14:44:44 -07:00
.eslintrc.yaml doc: enable eslint prefer-template rule 2018-02-22 14:56:17 +00:00
first_timer_badge.png doc: add recommendations for first timers 2017-10-24 10:26:20 -04:00
full-white-stripe.jpg
node.1 doc, src: sort + fill up cli options and env vars 2018-04-13 23:14:54 +03:00
onboarding-extras.md doc: move who-to-cc to COLABORATOR_GUIDE.md 2018-03-21 20:27:36 -07:00
onboarding.md doc: move who-to-cc to COLABORATOR_GUIDE.md 2018-03-21 20:27:36 -07:00
osx_installer_logo.png
releases.md doc: fix punctuation in doc/releases.md 2018-04-09 23:22:20 +02:00
STYLE_GUIDE.md doc,tools: formalize, unify, codify default values 2018-04-04 12:30:36 +03:00
template.html doc: responsive docs, rewrite font sizes 2017-10-10 21:28:15 +02:00
thin-white-stripe.jpg