delta/node-new.git/tools/doc, branch pull-request-doc-updates

test, tools: suppress addon function cast warnings

2019-02-01T13:08:20+00:00

Currently, there are a number of compiler warnings generated when
building the addons on Linux, for example:

make[1]: Entering directory '/node/test/addons/zlib-binding/build'
  CXX(target) Release/obj.target/binding/binding.o
  SOLINK_MODULE(target) Release/obj.target/binding.node
  COPY Release/binding.node
make[1]: Leaving directory '/node/test/addons/zlib-binding/build'
In file included from ../binding.cc:1:
/node/src/node.h:515:51: warning:
cast between incompatible function types from
'void (*)(v8::Local,
          v8::Local,
          v8::Local)' to
'node::addon_context_register_func' {aka
'void (*)(v8::Local,
          v8::Local,
          v8::Local,
          void*)'} [-Wcast-function-type]
(node::addon_context_register_func) (regfunc), \
					   ^
/node/src/node.h:533:3:
note: in expansion of macro 'NODE_MODULE_CONTEXT_AWARE_X'
   NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, NULL, 0)
   ^~~~~~~~~~~~~~~~~~~~~~~~~~~
../binding.cc:58:1:
note: in expansion of macro 'NODE_MODULE_CONTEXT_AWARE'
 NODE_MODULE_CONTEXT_AWARE(NODE_GYP_MODULE_NAME, Initialize)
 ^~~~~~~~~~~~~~~~~~~~~~~~~

This commit adds the flag -Wno-cast-function-type to suppress these
warnings. With this change the warnings are not displayed anymore and
the output matches that of osx when running
'make -j8 test/addons/.buildstamp'.

PR-URL: https://github.com/nodejs/node/pull/25663
Reviewed-By: Anna Henningsen 
Reviewed-By: Ben Noordhuis 
Reviewed-By: James M Snell 
Reviewed-By: Richard Lau

doc: fix, unify, formalize, and amplify vm.md

2019-01-11T20:21:44+00:00

`vm` module API heavily reuses common code, but the doc seems
to be a bit out of date: some options are listed in wrong places,
some options and history entries are missed.

Also some fragments need to be formalized and unified.

PR-URL: https://github.com/nodejs/node/pull/25422
Reviewed-By: Gus Caplan 
Reviewed-By: Ujjwal Sharma

doc: make modules.md more accurate

2019-01-07T23:16:51+00:00

PR-URL: https://github.com/nodejs/node/pull/25357
Reviewed-By: Anna Henningsen 
Reviewed-By: Colin Ihrig

doc: add documentation for brotli support

2019-01-05T20:36:48+00:00

PR-URL: https://github.com/nodejs/node/pull/24938
Reviewed-By: Ruben Bridgewater 
Reviewed-By: Matteo Collina 
Reviewed-By: Jan Krems 
Reviewed-By: James M Snell 
Reviewed-By: Myles Borins 
Reviewed-By: Ali Ijaz Sheikh 
Reviewed-By: Daniel Bevenius

crypto: add key object API

2018-12-24T13:50:16+00:00

This commit makes multiple important changes:

1. A new key object API is introduced. The KeyObject class itself is
   not exposed to users, instead, several new APIs can be used to
   construct key objects: createSecretKey, createPrivateKey and
   createPublicKey. The new API also allows to convert between
   different key formats, and even though the API itself is not
   compatible to the WebCrypto standard in any way, it makes
   interoperability much simpler.

2. Key objects can be used instead of the raw key material in all
   relevant crypto APIs.

3. The handling of asymmetric keys has been unified and greatly
   improved. Node.js now fully supports both PEM-encoded and
   DER-encoded public and private keys.

4. Conversions between buffers and strings have been moved to native
   code for sensitive data such as symmetric keys due to security
   considerations such as zeroing temporary buffers.

5. For compatibility with older versions of the crypto API, this
   change allows to specify Buffers and strings as the "passphrase"
   option when reading or writing an encoded key. Note that this
   can result in unexpected behavior if the password contains a
   null byte.

PR-URL: https://github.com/nodejs/node/pull/24234
Reviewed-By: Refael Ackermann 
Reviewed-By: James M Snell

tools: make apilinks building more robust

2018-12-18T04:14:24+00:00

1. Move the apilinks.json file into out/doc so it gets cleaned when
  running `make docclean`
2. When the apilinks.json generated is empty, throw a specific error
  so it's easier to understand what's wrong
3. Write to a file passed through CLI arguments instead writing to
  stdout in apilinks.js so the build process is more robust in
  the case of a bad binary

PR-URL: https://github.com/nodejs/node/pull/25019
Reviewed-By: Anna Henningsen 
Reviewed-By: James M Snell

doc,lib,test: capitalize comment sentences

2018-12-17T16:14:35+00:00

This activates the eslint capitalize comment rule for comments
above 50 characters.

PR-URL: https://github.com/nodejs/node/pull/24996
Reviewed-By: Ujjwal Sharma 
Reviewed-By: Anna Henningsen 
Reviewed-By: Sakthipriyan Vairamani 
Reviewed-By: James M Snell

tools,doc: fix version picker bug in html.js

2018-11-28T03:14:54+00:00

The processing of strings like `8.x` into a major version number and a
minor version number results in minor versions that are `NaN`. In that
situation, since the picker will link to the latest docs in the
major version, include the version in the version picker.

Fixes: https://github.com/nodejs/node/issues/23979
PR-URL: https://github.com/nodejs/node/pull/24638
Reviewed-By: Vse Mozhet Byt 
Reviewed-By: Ruben Bridgewater 
Reviewed-By: Refael Ackermann 
Reviewed-By: Luigi Pinca 
Reviewed-By: Franziska Hinkelmann

readline: add support for async iteration

2018-11-20T23:41:16+00:00

Co-authored-by: Ivan Filenko 
Fixes: https://github.com/nodejs/node/issues/18603
Refs: https://github.com/nodejs/node/pull/18904
PR-URL: https://github.com/nodejs/node/pull/23916
Reviewed-By: Matteo Collina 
Reviewed-By: Gus Caplan

tools: update alternative docs versions

2018-11-02T05:04:57+00:00

Add `11.x` and mark `10.x` as `lts`.

PR-URL: https://github.com/nodejs/node/pull/23980
Reviewed-By: Refael Ackermann 
Reviewed-By: Vse Mozhet Byt 
Reviewed-By: Trivikram Kamat 
Reviewed-By: Luigi Pinca