Bryan English
f0a2e2cdec
doc: message.header duplication correction
...
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 >
2015-12-05 15:55:58 +11:00
Lewis Cowper
4602e01221
doc: replace sane with reasonable
...
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 >
2015-12-05 15:55:56 +11:00
Tom Gallacher
4849a54386
doc: Adding best practises for crypto.pbkdf2
...
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 >
2015-12-05 15:55:56 +11:00
Carl Lei
77251d99de
doc: numeric flags to fs.open
...
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 >
2015-12-05 15:50:40 +11:00
Carl Lei
f4ca007b42
doc: clarify that fs streams expect blocking fd
...
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 >
2015-12-05 15:50:39 +11:00
Tristian Flanagan
13834caa28
module: fix column offsets in errors
...
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 >
2015-12-05 15:50:38 +11:00
Alexander Gromnitsky
26eeae8016
doc: fix broken references
...
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 >
2015-12-05 15:50:38 +11:00
Martin Forsberg
f90227b0e8
doc: move fs.existsSync() deprecation message
...
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 >
2015-12-05 15:47:47 +11:00
cjihrig
bbcb2a2e65
doc: clarify module loading behavior
...
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 >
2015-12-05 15:42:58 +11:00
cjihrig
0997178037
doc: add reference for buffer.inspect()
...
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 >
2015-12-05 15:42:57 +11:00
Jackson Tian
ce423f3624
debugger: introduce exec method for debugger
...
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 >
2015-12-05 15:42:37 +11:00
Stefan Budeanu
2f16be2b70
tls: Use SHA1 for sessionIdContext in FIPS mode
...
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 >
2015-11-17 12:25:40 -05:00
Tristian Flanagan
df1fdba2ae
doc: sort repl alphabetically
...
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 >
2015-11-17 11:37:12 -05:00
Bryan English
c2393d1f2a
doc: consistent reference-style links
...
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 >
2015-11-17 11:34:20 -05:00
Jesse McCarthy
96f53c6b02
doc: add link to [customizing util.inspect colors].
...
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 >
2015-11-17 11:24:58 -05:00
Tom Gallacher
132297d3f6
doc: Updated streams simplified constructor API
...
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 >
2015-11-17 11:24:50 -05:00
Roman Klauke
d137f0fd28
doc: add warning about Windows process groups
...
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 >
2015-11-17 11:24:40 -05:00
Manuel B
45ff31cf94
doc: added what buf.copy returns
...
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 >
2015-11-17 11:24:31 -05:00
Tristian Flanagan
5d1faa28cb
doc: reword message.headers to indicate they are not read-only
...
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 >
2015-11-17 11:24:24 -05:00
Bryan English
25c3807051
doc: clarify duplicate header handling
...
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 >
2015-11-17 11:24:12 -05:00
Bryan English
ae2d1ee302
doc: repl: add defineComand and displayPrompt
...
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 >
2015-11-17 11:22:10 -05:00
Tristian Flanagan
09e524d013
doc: sort tls alphabetically
...
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 >
2015-11-13 23:32:27 +11:00
Tristian Flanagan
7e60b81c81
doc: sort stream alphabetically
...
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 >
2015-11-13 23:32:27 +11:00
Tristian Flanagan
cd931a8a13
doc: sort net alphabetically
...
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 >
2015-11-13 23:32:27 +11:00
Tristian Flanagan
cfa8198af8
doc: sort process alphabetically
...
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 >
2015-11-13 23:32:27 +11:00
Tristian Flanagan
e1a512607a
doc: sort zlib alphabetically
...
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 >
2015-11-13 23:32:26 +11:00
Tristian Flanagan
0996b97240
doc: sort util alphabetically
...
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 >
2015-11-13 23:32:26 +11:00
Tristian Flanagan
df07072b66
doc: sort https alphabetically
...
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 >
2015-11-13 23:32:26 +11:00
Tristian Flanagan
6e9d01c7d8
doc: sort http alphabetically
...
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 >
2015-11-13 23:32:26 +11:00
Tristian Flanagan
18da02fa0f
doc: sort modules alphabetically
...
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 >
2015-11-13 23:32:26 +11:00
Tristian Flanagan
29054ffc0c
doc: sort readline alphabetically
...
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 >
2015-11-13 23:32:25 +11:00
Tristian Flanagan
389ead37ef
doc: sort repl alphabetically
...
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 >
2015-11-13 23:32:25 +11:00
Tristian Flanagan
d383d624de
doc: sort string_decoder alphabetically
...
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 >
2015-11-13 23:32:25 +11:00
Tristian Flanagan
0d2262887c
doc: sort timers alphabetically
...
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 >
2015-11-13 23:32:25 +11:00
Tristian Flanagan
14b5a95d03
doc: sort tty alphabetically
...
Reorders, with no contextual changes, the tty 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 >
2015-11-13 23:32:24 +11:00
Tristian Flanagan
d4dda77e4a
doc: sort url alphabetically
...
Reorders, with no contextual changes, the url 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 >
2015-11-13 23:32:24 +11:00
Tristian Flanagan
39b8259bd5
doc: sort vm alphabetically
...
Reorders, with no contextual changes, the vm 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 >
2015-11-13 23:32:24 +11:00
Tristian Flanagan
d357b3090e
doc: sort querystring alphabetically
...
Reorders, with no contextual changes, the querystring 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 >
2015-11-13 23:32:24 +11:00
Tristian Flanagan
1f56abaa98
doc: sort punycode alphabetically
...
Reorders, with no contextual changes, the punycode 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 >
2015-11-13 23:32:23 +11:00
Tristian Flanagan
bc63667456
doc: sort path alphabetically
...
Reorders, with no contextual changes, the path 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 >
2015-11-13 23:32:23 +11:00
Tristian Flanagan
22961e011c
doc: sort os alphabetically
...
Reorders, with no contextual changes, the os 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 >
2015-11-13 23:32:23 +11:00
Tristian Flanagan
4ba18489d3
doc: sort globals alphabetically
...
Reorders, with no contextual changes, the globals 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 >
2015-11-13 23:32:23 +11:00
Tristian Flanagan
c3f5ea704f
doc: sort fs alphabetically
...
Reorders, with no contextual changes, the fs 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 >
2015-11-13 23:32:23 +11:00
Tristian Flanagan
ce3ac8dd1e
doc: sort events alphabetically
...
Reorders, with minimal contextual duplication, the events 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 >
2015-11-13 23:32:22 +11:00
Tristian Flanagan
63a78749b8
doc: sort errors alphabetically
...
Reorders, with no contextual changes, the errors 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 >
2015-11-13 23:32:22 +11:00
Tristian Flanagan
488326da8d
doc: sort dgram alphabetically
...
Reorders, with no contextual changes, the dgram 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 >
2015-11-13 23:32:22 +11:00
Tristian Flanagan
e1c357e881
doc: sort crypto alphabetically
...
Reorders, with no contextual changes, the crypto 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 >
2015-11-13 23:32:22 +11:00
Tristian Flanagan
4118fd5794
doc: sort dns alphabetically
...
Reorders, with no contextual changes, the dns 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 >
2015-11-13 23:32:21 +11:00
Tristian Flanagan
3e046acc50
doc: sort console alphabetically
...
Reorders, with no contextual changes, the console 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 >
2015-11-13 23:32:21 +11:00
Tristian Flanagan
05f1af7124
doc: sort cluster alphabetically
...
Reorders, with no contextual changes, the cluster 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 >
2015-11-13 23:32:21 +11:00