summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* crypto: simplify using pre-existing keys with ECDHMichael Ruddy2015-12-071-10/+38
| | | | | | | | | | | | | | | These changes simplify using ECDH with private keys that are not dynamically generated with ECDH.generateKeys. Support for computing the public key corresponding to the given private key was added. Validity checks to reduce the possibility of computing a weak or invalid shared secret were also added. Finally, ECDH.setPublicKey was softly deprecated. PR-URL: https://github.com/nodejs/node/pull/3511 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp>
* fs,doc: use `target` instead of `destination`yorkie2015-12-051-3/+9
| | | | | | | | | PR-URL: https://github.com/nodejs/node/pull/3912 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Bert Belder <bertbelder@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: url.format - true slash postfix behaviourfansworld-claudio2015-12-061-2/+2
| | | | | | | | | | | | | Change url.format's references to slash postfixing to reflect true behaviour (it only automatically postfixes slashes to the slashedProtocols when host is present). Fixes: #3361 PR-URL: https://github.com/nodejs/node/pull/4119 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
* doc: improve child_process.markdown wordingyorkie2015-12-041-3/+3
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/4138 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Minwoo Jung <jmwsoft@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: update links to use https where possiblejpersson2015-12-038-25/+25
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
* doc: add links and backticks around namesjpersson2015-12-0327-625/+712
| | | | | | | | | | | | | | * add backticks around names * add single quotes around event names * add parenthesis after function names * add internal links between different sections * add external links to MDN for some JavaScript references * sort the link definitions alphabetically PR-URL: https://github.com/nodejs/node/pull/4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
* doc: standardize references to node.js in docsScott Buchanan2015-12-032-2/+2
| | | | | | | | | | trivial commit to fix a couple inconsistent references to the name of the project PR-URL: https://github.com/nodejs/node/pull/4136 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Roman Klauke <romaaan.git@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
* doc: reword https.Agent example textJan Krems2015-12-021-1/+1
| | | | | PR-URL: https://github.com/nodejs/node/pull/4075 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: fix internal link to child.send()Luigi Pinca2015-12-011-2/+1
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/4089 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: fix the exception descriptionyorkie2015-11-301-3/+4
| | | | | | | | | | | A value shouldn't be described as doing inherit from some class, more strictly, the value is an instance of the class `Error`. PR-URL: https://github.com/nodejs/node/pull/3658 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Stephan Belanger <admin@stephenbelanger.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
* doc: fix color of linked code blocksjpersson2015-11-301-0/+4
| | | | | | | | Links nested in backticks were not visually distinguishable before, this fixes them. PR-URL: https://github.com/nodejs/node/pull/4068 Reviewed-By: Roman Reiss <me@silverwind.io>
* path: make format() consistent and more functionalNathan Woltman2015-11-271-0/+10
| | | | | | | | | | | | | | Make the win32 and posix versions of path.format() consistent in when they add a directory separator between the dir and base parts of the path (always add it unless the dir part is the same as the root). Also, path.format() is now more functional in that it uses the name and ext parts of the path if the base part is left out and it uses the root part if the dir part is left out. Reviewed-By: João Reis <reis@janeasystems.com> Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/2408
* doc: fix rare case of misaligned columnsRoman Reiss2015-11-271-1/+1
| | | | | | | | | | | By using the same unit for the offset of the main column as used for the left column width, we ensure that browsers render the columns conistently. Ref: https://github.com/nodejs/help/issues/32 PR-URL: https://github.com/nodejs/node/pull/3948 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: message.header duplication correctionBryan English2015-11-241-5/+2
| | | | | | | | | | | The old version of the text here was slightly incorrect, so it just defers the details to the section in which they're fully described. PR-URL: https://github.com/nodejs/node/pull/3997 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com>
* doc: replace sane with reasonableLewis Cowper2015-11-231-1/+1
| | | | | | | | | | Removing ableist language because we don't need to make the comparison to people with mental health issues to get our point across. PR-URL: https://github.com/nodejs/node/pull/3980 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: Adding best practises for crypto.pbkdf2Tom Gallacher2015-11-231-1/+9
| | | | | | | | | | Added some information around usages of how to use iterations, how to choose decent salts and updating the example to have a significant work factor and to use sha512. PR-URL: https://github.com/nodejs/node/pull/3290 Reviewed-By: Fedor Indutny <fedor@indutny.com> Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp>
* doc: numeric flags to fs.openCarl Lei2015-11-221-0/+5
| | | | | | | | This has been supperted for long but never tested nor documented. PR-URL: https://github.com/nodejs/node/pull/3641 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: clarify that fs streams expect blocking fdCarl Lei2015-11-221-1/+4
| | | | | | | | | | This clarifies that fs.createReadStream and fs.createWriteStream, when passed a fd, expects the fd to be blocking, and suggests net.Socket as an alternative. PR-URL: https://github.com/nodejs/node/pull/3641 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com>
* module: fix column offsets in errorsTristian Flanagan2015-11-201-2/+18
| | | | | | | | | | | | | Because Node modules are wrapped, errors on the first line of a file leak the wrapper to the user and report the wrong column number. This commit adds a line break to the module wrapper so that the first line is treated the same as all other lines. To compensate for the additional line, a line offset of -1 is also applied to errors. Fixes: https://github.com/nodejs/node/issues/2860 PR-URL: https://github.com/nodejs/node/pull/2867 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: fix broken referencesAlexander Gromnitsky2015-11-204-4/+4
| | | | | | PR-URL: https://github.com/nodejs/node/pull/3944 Reviewed-By: targos - Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Myles Borins <mborins@us.ibm.com>
* doc: move fs.existsSync() deprecation messageMartin Forsberg2015-11-201-2/+2
| | | | | | | | | This commit moves the deprecation message for fs.existsSync() above the function description, making message placement uniform across the documentation. PR-URL: https://github.com/nodejs/node/pull/3942 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: clarify module loading behaviorcjihrig2015-11-191-1/+2
| | | | | | | | | | | The module loading system will not append node_modules to a path already ending in node_modules. This used to be documented, but it was lost. Fixes: https://github.com/nodejs/node/issues/3873 PR-URL: https://github.com/nodejs/node/pull/3920 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
* doc: add reference for buffer.inspect()cjihrig2015-11-191-1/+3
| | | | | | | | | | This commit refers readers to util.inspect() for an explanation of buffer.inspect(). Fixes: https://github.com/nodejs/node/issues/3918 PR-URL: https://github.com/nodejs/node/pull/3921 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
* util: remove pumpWyatt Preul2015-11-181-6/+0
| | | | | | | | Remove util.pump and associated tests PR-URL: https://github.com/nodejs/node/pull/2531 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* tty: Remove deprecated setRawMode wrapperWyatt Preul2015-11-181-4/+0
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/2528 Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* debugger: introduce exec method for debuggerJackson Tian2015-11-171-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In debugger, the usage of `repl` very ugly. I'd like there is a `p` like gdb. So the `exec` is coming. Usage: ``` $ ./iojs debug ~/git/node_research/server.js < Debugger listening on port 5858 connecting to 127.0.0.1:5858 ... ok break in /Users/jacksontian/git/node_research/server.js:1 > 1 var http = require('http'); 2 3 http.createServer(function (req, res) { debug> exec process.title /Users/jacksontian/git/io.js/out/Release/iojs debug> ``` And the `repl`: ``` debug> repl Press Ctrl + C to leave debug repl > process.title '/Users/jacksontian/git/io.js/out/Release/iojs' debug> (^C again to quit) ``` The enter and leave debug repl is superfluous. R-URL: https://github.com/nodejs/node/pull/1491 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: sort repl alphabeticallyTristian Flanagan2015-11-161-83/+83
| | | | | | | | | Reorders, with no contextual changes, the repl documentation with class definitions at the top and alphabetically. PR-URL: https://github.com/nodejs/node/pull/3859 Reviewed-By: Roman Klauke <romaaan.git@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* tls: use SHA1 for sessionIdContextStefan Budeanu2015-11-161-3/+3
| | | | | | | | | FIPS 140-2 disallows use of MD5, which is used to derive the default sessionIdContext for tls.createServer(). PR-URL: https://github.com/nodejs/node/pull/3866 Reviewed-By: Fedor Indutny <fedor@indutny.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* tls: Use SHA1 for sessionIdContext in FIPS modeStefan Budeanu2015-11-161-1/+2
| | | | | | | | FIPS 140-2 disallows use of MD5, which is used to derive the default sessionIdContext for tls.createServer(). PR-URL: https://github.com/nodejs/node/pull/3755 Reviewed-By: Fedor Indutny <fedor@indutny.com>
* doc: consistent reference-style linksBryan English2015-11-1628-311/+372
| | | | | | | | Moved all the URLs in API docs to the bottom of the files as reference-style links. PR-URL: https://github.com/nodejs/node/pull/3845 Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: add link to [customizing util.inspect colors].Jesse McCarthy2015-11-131-1/+2
| | | | | | PR-URL: https://github.com/nodejs/node/pull/3749 Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: Updated streams simplified constructor APITom Gallacher2015-11-131-0/+35
| | | | | | | | | The examples for implementing the simplified constructor API was missing some details on its correct usages. PR-URL: https://github.com/nodejs/node/pull/3602 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us>
* doc: add warning about Windows process groupsRoman Klauke2015-11-131-1/+2
| | | | | | | | | | This commit adds a warning for Windows platforms. `process.kill` wont kill a process group on Windows and instead it throws an error. Refs: https://github.com/nodejs/node/issues/3617 PR-URL: https://github.com/nodejs/node/pull/3681 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: added what buf.copy returnsManuel B2015-11-131-0/+2
| | | | | | | | | | as of https://github.com/nodejs/node/blob/v5.x/src/node_buffer.cc#L555 buf.copy returns the number of bytes copied. PR-URL: https://github.com/nodejs/node/pull/3555 Reviewed-By: Trevor Norris <trev.norris@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: reword message.headers to indicate they are not read-onlyTristian Flanagan2015-11-131-1/+1
| | | | | | | | | | | message.headers states that the headers are read-only, when in fact they are not. This change rewords the docs to a more appropriate description, while not promoting this kind of behavior. Fixes: #3146 PR-URL: https://github.com/nodejs/node/pull/3814 Reviewed-By: Roman Klauke <romaaan.git@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: clarify duplicate header handlingBryan English2015-11-131-0/+10
| | | | | | | | | This commit documents how duplicate HTTP headers are handled. PR-URL: https://github.com/nodejs/node/pull/3810 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
* doc: repl: add defineComand and displayPromptBryan English2015-11-131-7/+55
| | | | | | | | Also some minor edits so the additions make sense. PR-URL: https://github.com/nodejs/node/pull/3765 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
* doc: sort tls alphabeticallyTristian Flanagan2015-11-121-520/+507
| | | | | | | | | | Reorders, with no contextual changes, the tls documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort stream alphabeticallyTristian Flanagan2015-11-121-512/+504
| | | | | | | | | | Reorders, with no contextual changes, the stream documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort net alphabeticallyTristian Flanagan2015-11-121-334/+379
| | | | | | | | | | Reorders, with minimal contextual duplication, the net documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort process alphabeticallyTristian Flanagan2015-11-121-463/+437
| | | | | | | | | | Reorders, with no contextual changes, the process documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort zlib alphabeticallyTristian Flanagan2015-11-121-153/+158
| | | | | | | | | | | | | Reorders, with some contextual changes, the zlib documentation alphabetically. - Put Convenience Methods children under the Convenience Methods header - Renamed Options to Class Options and put above the Class definitions PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort util alphabeticallyTristian Flanagan2015-11-121-153/+149
| | | | | | | | | | Reorders, with no contextual changes, the util documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort https alphabeticallyTristian Flanagan2015-11-121-52/+49
| | | | | | | | | | Reorders, with no contextual changes, the https documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort http alphabeticallyTristian Flanagan2015-11-121-639/+629
| | | | | | | | | | Reorders, with no contextual changes, the http documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort modules alphabeticallyTristian Flanagan2015-11-121-242/+236
| | | | | | | | | | Reorders, with no contextual changes, the modules documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort readline alphabeticallyTristian Flanagan2015-11-121-106/+105
| | | | | | | | | | Reorders, with no contextual changes, the readline documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort repl alphabeticallyTristian Flanagan2015-11-121-94/+93
| | | | | | | | | | Reorders, with no contextual changes, the repl documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort string_decoder alphabeticallyTristian Flanagan2015-11-121-4/+4
| | | | | | | | | | Reorders, with no contextual changes, the string_decode documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: sort timers alphabeticallyTristian Flanagan2015-11-121-37/+37
| | | | | | | | | | Reorders, with no contextual changes, the timers documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>