aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2016-01-13doc: fix typo in doc/node.1Jérémy Lal
PR-URL: https://github.com/nodejs/node/pull/4680 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-13doc: make references clickableRoman Klauke
The child_process docs contained some links, but some links were somehow "broken". `make doc` couldn't translate them and left `[]` in the compiled HTML. PR-URL: https://github.com/nodejs/node/pull/4654 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-13doc: add CTC meeting minutes 2016-01-06Rod Vagg
PR-URL: https://github.com/nodejs/node/pull/4667 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-13doc: add CTC meeting minutes 2015-12-16Rod Vagg
PR-URL: https://github.com/nodejs/node/pull/4666 Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-13doc: add CTC meeting minutes 2015-12-02Rod Vagg
PR-URL: https://github.com/nodejs/node/pull/4665 Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-13doc: add CTC meeting minutes 2015-11-11Rod Vagg
PR-URL: https://github.com/nodejs/node/pull/4664 Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-13doc: add CTC meeting minutes 2015-11-04Rod Vagg
PR-URL: https://github.com/nodejs/node/pull/4663 Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-13doc: improve child_process.execFile() code exampleRyan Sobol
PR-URL: https://github.com/nodejs/node/pull/4504 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
2016-01-13docs: fix npm command in releases.mdMyles Borins
PR-URL: https://github.com/nodejs/node/pull/4656 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-13http: improves expect header handlingDaniel Sellers
Now returns a 417 error status or allows for an event listener on the `checkExpectation` event. Before we were ignoring requests that had misspelled `100-continue` values for expect headers. This is a quick port of the work done here: https://github.com/nodejs/node-v0.x-archive/pull/7132 by alFReD-NSH with surrounding discussion here: https://github.com/nodejs/node-v0.x-archive/issues/4651 Also updates all the instances of the deprecated EventEmitter.listenerCount to the current self.listenerCount. Most of these were in the new code ported over but there was another legacy instance. Refs: #2403 PR-URL: https://github.com/nodejs/node/pull/4501 Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-12doc: add docs for more stream optionszoubin
PR-URL: https://github.com/nodejs/node/pull/4639 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Chris Dickinson <chris@neversaw.us>
2016-01-12doc: add branch-diff example to releases.mdMyles Borins
Useful to have for reference, especially for onboarding PR-URL: https://github.com/nodejs/node/pull/4636 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell<jasnell@gmail.com>
2016-01-11fs: add autoClose option to fs.createWriteStreamSaquib
Add support to fs.createWriteStream and fs.createWriteStream for an autoClose option that behaves similarly to the autoClose option supported by fs.createReadStream and fs.ReadStream. When an instance of fs.createWriteStream created with autoClose === false finishes, it is not destroyed. Its underlying fd is not closed and it is the responsibility of the user to close it. PR-URL: https://github.com/nodejs/node/pull/3679 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2016-01-11doc: adds usage of readline line-by-line parsingRobert Jefe Lindstaedt
In order to make developers aware of node-core built-in functionality, which might replace module APIs, we should add an example of readline`s interface usage. SEO will eventually aid this goal, since it is well searched on Q&A sites. PR-URL: https://github.com/nodejs/node/pull/4609 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com>>
2016-01-11doc: remove "above" and "below" referencesRichard Sun
The docs were recently refactored, and some "above" and "below" references were no longer accurate. This commit removes many such references, and replaces others with links. PR-URL: https://github.com/nodejs/node/pull/4499 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-11doc: update stylesheet to match frontpageRoman Reiss
- Changed colors to match frontpage as close as possible. - Links are slightly more horizontally padded as compared before to accomodate for the hover effect. - Slightly reduced the scroll indication height on the TOC. - The main content is now offset using margin instead of the previous border hack. - remove empty footer that was rendering a dark bar on the bottom of each page without any content. PR-URL: https://github.com/nodejs/node/pull/4621 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-01-11doc: stronger suggestion for userland assertWyatt Preul
Fixes: https://github.com/nodejs/node/issues/4532 PR-URL: https://github.com/nodejs/node/pull/4535 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-01-11doc: label http.IncomingMessage as a ClassSequoia McDowell
`Server`, `ServerResponse` etc. were marked as classes, this one class was overlooked. PR-URL: https://github.com/nodejs/node/pull/4589 Fixes: https://github.com/nodejs/node/issues/4576 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-01-11doc: document http's server.listen return valueSequoia McDowell
The server method returns `self` in order to allow chaining. PR-URL: https://github.com/nodejs/node/pull/4590 Fixes: https://github.com/nodejs/node/issues/4571 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-01-07http: overridable `clientError`Fedor Indutny
Make default `clientError` behavior (close socket immediately) overridable. With this APIs it is possible to write a custom error handler, and to send, for example, a 400 HTTP response. http.createServer(...).on('clientError', function(err, socket) { socket.end('HTTP/1.1 400 Bad Request\r\n\r\n'); socket.destroy(); }); Fix: #4543 PR-URL: https://github.com/nodejs/node/pull/4557 Reviewed-By: Brian White <mscdex@mscdex.net>
2016-01-07tls: rename `clientError` to `tlsClientError`Fedor Indutny
`clientError` will have `http.Server`-specific behavior, and we don't want to shadow it in `tls.Server`. PR-URL: https://github.com/nodejs/node/pull/4557 Reviewed-By: Brian White <mscdex@mscdex.net>
2016-01-06doc: bring releases.md up to datecjihrig
Refs: https://github.com/nodejs/node/issues/3254 PR-URL: https://github.com/nodejs/node/pull/4540 Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-06doc: add missing backtick for readlineBrian White
PR-URL: https://github.com/nodejs/node/pull/4549 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2016-01-06doc: improvements to crypto.markdown copyJames M Snell
General improvements to crypto.markdown including new and revised examples. PR-URL: https://github.com/nodejs/node/pull/4435 Reviewed-By: Fedor Indutny <fedor@indutny.com> Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp>
2016-01-05doc: fix heading level error in Buffer docShigeki Ohtsu
tools/doc/html.js in make doc throws an error in checking a heading level in the markdown file. PR-URL: https://github.com/nodejs/node/pull/4537 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-05doc: close backtick in process.title descriptionDave
PR-URL: https://github.com/nodejs/node/pull/4534 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
2016-01-05doc: fix numbering in stream.markdownRichard Sun
PR-URL: https://github.com/nodejs/node/pull/4538 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2016-01-04doc: improvements to dgram.markdown copyJames M Snell
General improvements to dgram.markdown copy PR-URL: https://github.com/nodejs/node/pull/4437 Reviewed-By: Minwoo Jung <jmwsoft@gmail.com> Reviewed-By: Stephan Belanger <admin@stephenbelanger.com>
2016-01-04doc: improvements to errors.markdown copyJames M Snell
General improvements to errors.markdown including improved/revised examples PR-URL: https://github.com/nodejs/node/pull/4454 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
2016-01-04timers: fail early when callback is not a functionAnna Henningsen
`setTimeout()`, `setInterval()` and `setIntermediate` currently throw errors when receiving non-function objects as their first argument, but only do so when trying to execute the callback, i.e. after the waited time has passed. This may complicate debugging when a lot of calls to `setTimeout()`/etc. are involved, so failing as early as possible seems like a good idea. `setTimeout()` historically ignored an falsy first argument, while the other functions do not and throw instead. This patch changes this behaviour to make all three match and adds remarks in the corresponding documentation. PR-URL: https://github.com/nodejs/node/pull/4362 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Trevor Norris <trev.norris@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org>
2015-12-30doc: mention that http.Server inherits from net.ServerRyan Sobol
PR-URL: https://github.com/nodejs/node/pull/4455 Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2015-12-30doc: explain ClientRequest#setTimeout time unitBen Ripkens
State a time unit for the timeout parameter in ClientRequest#setTimeout PR-URL: https://github.com/nodejs/node/pull/4458 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2015-12-30doc: add anchors for _transform _flush _writev in stream.markdowniamchenxin
PR-URL: https://github.com/nodejs/node/pull/4448 Reviewed-By: Trevor Norris <trev.norris@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2015-12-30doc: improvements to debugger.markdown copyJames M Snell
General improvements to debugger.markdown PR-URL: https://github.com/nodejs/node/pull/4436 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Minwoo Jung <jmwsoft@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2015-12-30doc: improvements to events.markdown copyJames M Snell
General improvements to events.markdown copy including a bit of restructuring and improved examples PR-URL: https://github.com/nodejs/node/pull/4468 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
2015-12-30doc: improvements to dns.markdown copyJames M Snell
General improvements to dns.markdown copy and examples PR-URL: https://github.com/nodejs/node/pull/4449 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
2015-12-30doc: improvements to console.markdown copyJames M Snell
Several improvements including a few new examples PR-URL: https://github.com/nodejs/node/pull/4428 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com>
2015-12-30doc: improve child_process.markdown copyJames M Snell
General improvements to child_process.markdown PR-URL: https://github.com/nodejs/node/pull/4383 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2015-12-29doc: copyedit setTimeout() documentationRich Trott
Copyedit the documentation for setTimeout() and enforce wrapping at 80 characters in the markdown file for nearby text. PR-URL: https://github.com/nodejs/node/pull/4434 Reviewed-By: Trevor Norris <trev.norris@gmail.com> Reviewed-By: jasnell - James M Snell <jasnell@gmail.com> Reviewed-By: Stephan Belanger <admin@stephenbelanger.com>
2015-12-29doc: fix formatting in process.markdownRich Trott
All the other properties get an h2/## but process.connected gets an h3/### for no discernible reason. Change it to h2/## like the others. PR-URL: https://github.com/nodejs/node/pull/4433 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Stephan Belanger <admin@stephenbelanger.com> Reviewed-By: Roman Klauke <romaaan.git@gmail.com>
2015-12-28doc: improve assert.markdown copyJames M Snell
General improvements to assert.markdown copy including new and improved examples PR-URL: https://github.com/nodejs/node/pull/4360 Reviewed-By: Trevor Norris <trev.norris@gmail.com>
2015-12-23doc: copyedit releases.mdRich Trott
PR-URL: https://github.com/nodejs/node/pull/4384 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2015-12-23doc: improve grammar in tls docsAdri Van Houdt
Fix: #4246 PR-URL: https://github.com/nodejs/node/pull/4315 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Fedor Indutny <fedor@indutny.com>
2015-12-23doc: improvements to buffer.markdown copyJames M Snell
General improvements to buffer.markdown including new examples, a few fixes to existing examples, consistent formatting and others PR-URL: https://github.com/nodejs/node/pull/4370 Reviewed-By: Trevor Norris <trev.norris@gmail.com>
2015-12-23doc: improve addons.markdown copyJames M Snell
General improvements to the documentation in addons.markdown. PR-URL: https://github.com/nodejs/node/pull/4320 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2015-12-17doc: fix, modernize examples in docsJames M Snell
* Use single quotes consistently * Modernize examples to use template strings and arrow funcs * Fix a few typos * Example edits for consistency PR-URL: https://github.com/nodejs/node/pull/4282 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2015-12-17doc: Typo in buffer.markdown referencing buf.write()chrisjohn404
The buffer's write function is documented below the buf.toString function and all of the docs reference "buf" instead of "buffer". PR-URL: https://github.com/nodejs/node/pull/4324 Reviewed-By: James M Snell <jasnell@gmail.com>
2015-12-17doc: fix link in addons.markdownNicholas Young
Update link from github.com/rvagg to github.com/nodejs PR-URL: https://github.com/nodejs/node/pull/4331 Reviewed-By: James M Snell <jasnell@gmail.com>
2015-12-16doc: document the cache parameter for fs.realpathSyncJackson Tian
PR-URL: https://github.com/nodejs/node/pull/4285 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2015-12-16doc: document backlog for server.listen() variantsJan Schär
The backlog parameter is supported by all variations of net.Server.listen(), but wasn't consistently documented. This commit brings the documentation into a more consistent state. Refs: https://github.com/nodejs/node/pull/4056 PR-URL: https://github.com/nodejs/node/pull/4025 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-12 21:56:48 +0000