aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2016-06-07buffer: introduce latin1 encoding termTrevor Norris
When node began using the OneByte API (f150d56) it also switched to officially supporting ISO-8859-1. Though at the time no new encoding string was introduced. Introduce the new encoding string 'latin1' to be more explicit. The previous 'binary' and documented as an alias to 'latin1'. While many tests have switched to use 'latin1', there are still plenty that do both 'binary' and 'latin1' checks side-by-side to ensure there is no regression. PR-URL: https://github.com/nodejs/node/pull/7111 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-07doc: clarify rl.question callback argsJames M Snell
Clarify that readline's rl.question() callback does not use the err back pattern. Fixes: https://github.com/nodejs/node/issues/4833 PR-URL: https://github.com/nodejs/node/pull/7022 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2016-06-07doc: general improvements to readline.md copyJames M Snell
PR-URL: https://github.com/nodejs/node/pull/7022 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2016-06-06doc: use consistent typography in streams.mdRich Trott
In prose, always surround `null`-as-a-value in backticks. PR-URL: https://github.com/nodejs/node/pull/6986 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
2016-06-06doc: general improvements to process.md copyJames M Snell
PR-URL: https://github.com/nodejs/node/pull/7029 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2016-06-06doc: general improvements to repl.md copyJames M Snell
The repl documentation has always been rather lacking. This is a first step towards making significant improvements. PR-URL: https://github.com/nodejs/node/pull/7002 Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-06doc: add `added:` information for readlineJulian Duque
Got the information from git history, I added the version when Interface was exported as class (v0.1.104), it was an internal class on previous versions. Refs: https://github.com/nodejs/node/issues/6578 PR-URL: https://github.com/nodejs/node/pull/6996 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-06doc: improved syntax consistency in console.mdJonathan Montane
`stdout` was written as `inline code` most of the time, except for the `console.time` and `console.timeEnd` functions which made it a bit more tedious to read about. Now it's always using inline code. PR-URL: https://github.com/nodejs/node/pull/7062 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-06doc: clarify fs.access works on directories too.Lance Ball
This is maybe more verbose than needed, since the same information is repeated several times. An alternative, maybe a single short sentence at the beginning is better. E.g. Fixes: https://github.com/nodejs/node/issues/7110 PR-URL: https://github.com/nodejs/node/pull/7113 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-06doc: general improvements to querystring.md copyJames M Snell
PR-URL: https://github.com/nodejs/node/pull/7023 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-06-06doc: fix header depth of util.isSymbolJames M Snell
PR-URL: https://github.com/nodejs/node/pull/7138 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-06doc: general improvements to stream.md copyJames M Snell
Majoring restructuring and update for streams doc. This is the first step of multiple to updating and correcting the streams documentation. PR-URL: https://github.com/nodejs/node/pull/6947 Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2016-06-03doc: add `added:` information for dnsJulian Duque
Got the information from git history and I ignored previous version of dns attached to `node.dns` (pre v0.1.16). There is a case where `dns.resolveNaptr` were intented to be in v0.7.12 and it was reverted and addec back on `v0.9.12`, I left the latest version when module was introduced. Same for `dns.resolvePtr` who was referenced before but it was only added on `v6.0.0` Refs: https://github.com/nodejs/node/issues/6578 PR-URL: https://github.com/nodejs/node/pull/7021 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-03doc: add `added:` information for pathJulian Duque
Got the information from git history mostly, I ignored previous path methods attached to `node.path` (pre v0.1.16). Refs: https://github.com/nodejs/node/issues/6578 PR-URL: https://github.com/nodejs/node/pull/6985 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-02doc: add `added` information for netItalo A. Casas
Ref: https://github.com/nodejs/node/issues/6578 PR-URL: https://github.com/nodejs/node/pull/7038 Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-02doc: general improvements to punycode.md copyJames M Snell
PR-URL: https://github.com/nodejs/node/pull/7025 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2016-06-032016-06-02, Version 6.2.1 (Current)Rod Vagg
* buffer: Ignore negative lengths in calls to Buffer() and Buffer.allocUnsafe(). This fixes a possible security concern (reported by Feross Aboukhadijeh) where user input is passed unchecked to the Buffer constructor or allocUnsafe() as it can expose parts of the memory slab used by other Buffers in the application. Note that negative lengths are not supported by the Buffer API and user input to the constructor should always be sanitised and type-checked. (Anna Henningsen) https://github.com/nodejs/node/pull/7030 * npm: Upgrade npm to 3.9.3 (Kat Marchán) https://github.com/nodejs/node/pull/7030 * tty: Default to blocking mode for stdio on OS X. A bug fix in libuv 1.9.0, introduced in Node.js v6.0.0, exposed problems with Node's use of non-blocking stdio, particularly on OS X which has a small output buffer. This change should fix CLI applications that have been having problems with output since Node.js v6.0.0 on OS X. The core team is continuing to address stdio concerns that exist across supported platforms and progress can be tracked at https://github.com/nodejs/node/pull/6980. (Jeremiah Senkpiel) https://github.com/nodejs/node/pull/6895 * V8: Upgrade to V8 5.0.71.52. This includes a fix that addresses problems experienced by users of node-inspector since Node.js v6.0.0, see https://github.com/nodejs/node/issues/6980 for details. (Michaël Zasso) https://github.com/nodejs/node/pull/6928
2016-06-02doc: add links to platform specific mechanismsMichael Dawson
As requested in earlier PR adding detail for Aix, add link for each of the platform specific technologies used for file system watching. PR-URL: https://github.com/nodejs/node/pull/7071 Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
2016-06-01tty: use blocking mode on OS XJeremiah Senkpiel
OS X has a tiny 1kb hard-coded buffer size for stdout / stderr to TTYs (terminals). Output larger than that causes chunking, which ends up having some (very small but existent) delay past the first chunk. That causes two problems: 1. When output is written to stdout and stderr at similar times, the two can become mixed together (interleaved). This is especially problematic when using control characters, such as \r. With interleaving, chunked output will often have lines or characters erased unintentionally, or in the wrong spots, leading to broken output. CLI apps often extensively use such characters for things such as progress bars. 2. Output can be lost if the process is exited before chunked writes are finished flushing. This usually happens in applications that use `process.exit()`, which isn't infrequent. See https://github.com/nodejs/node/issues/6980 for more info. This became an issue as result of the Libuv 1.9.0 upgrade. A fix to an unrelated issue broke a hack previously required for the OS X implementation. This resulted in an unexpected behavior change in node. The 1.9.0 upgrade was done in c3cec1eefc9f3b55a3fb7bd623b3d921f493870d, which was included in v6.0.0. Full details of the Libuv issue that induced this are at https://github.com/nodejs/node/issues/6456#issuecomment-219974514 Refs: https://github.com/nodejs/node/pull/1771 Refs: https://github.com/nodejs/node/issues/6456 Refs: https://github.com/nodejs/node/pull/6773 Refs: https://github.com/nodejs/node/pull/6816 PR-URL: https://github.com/nodejs/node/pull/6895 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-01doc: improve rendering of v4.4.5 changelog entryMyles Borins
Remove extra newlines that were causing rendering problems. PR-URL: https://github.com/nodejs/node/pull/6958 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2016-05-31doc: addresses nits in string_decoder, url, utilJeremiah Senkpiel
- Only `@@toStringTag` affects `util.isError()`, this is the reason why it uses `Object.prototype.toString.call(argument)` under the hood. - Shows an actual Euro symbol for reference. - Uses line-drawing characters for the URL chart & fixes the chart borders. PR-URL: https://github.com/nodejs/node/pull/7026 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2016-05-30src,lib: v8-inspector supportPavel Feldman
This change introduces experimental v8-inspector support. This brings the DevTools debug protocol allowing Node.js to be debugged with Chrome DevTools native, or through other debuggers supporting that protocol. Partial WebSocket support, to the extent required by DevTools, is included. This is derived from the implementation in Blink. v8-inspector support can be disabled by the --without-inspector configure flag. PR-URL: https://github.com/nodejs/node/pull/6792 Reviewed-By: jasnell - James M Snell <jasnell@gmail.com> Reviewed-By: addaleax - Anna Henningsen <anna@addaleax.net> Reviewed-By: bnoordhuis - Ben Noordhuis <info@bnoordhuis.nl>
2016-05-30doc,test: add `How to write a Node.js test` guideSantiago Gimeno
PR-URL: https://github.com/nodejs/node/pull/6984 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
2016-05-29doc: improve debugger doc proseRich Trott
PR-URL: https://github.com/nodejs/node/pull/7007 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-05-29doc: update labels and CI info in onboarding docRich Trott
PR-URL: https://github.com/nodejs/node/pull/7006 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2016-05-29doc: buffers are not sent over IPC with a socketTim Kuijsten
If a socket is sent to a child, any data that is buffered in the socket will not be sent to the child. The child will only receive data from the socket that is sent after the child has the socket. PR-URL: https://github.com/nodejs/node/pull/6951 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-05-29doc: minor improvements to util.mdSakthipriyan Vairamani
PR-URL: https://github.com/nodejs/node/pull/6932 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-05-28doc: add `added:` information for vmAnna Henningsen
Ref: https://github.com/nodejs/node/issues/6578 PR-URL: https://github.com/nodejs/node/pull/7011 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Julian Duque <julianduquej@gmail.com>
2016-05-28doc: add `added:` information for consoleAdrian Estrada
Information extracted from git history. Ref: https://github.com/nodejs/node/issues/6578 PR-URL: https://github.com/nodejs/node/pull/6995 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Julian Duque <julianduquej@gmail.com>
2016-05-27build: re-add --ninja option to configureEhsan Akhgari
Ninja is a build backend supported by gyp which is much faster than Make and is able to parallelize builds across all of the available cores very well. On my machine, this reduces the average build time from 5:14 minutes to 4:33 minutes. Refs: https://github.com/nodejs/node/pull/467 Refs: de224d6e6c9381e71ffee965dbda928802cc438e PR-URL: https://github.com/nodejs/node/pull/6780 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2016-05-27doc: add info on what's used for fswatch on AIXMichael Dawson
Info is provided on for the other OS's. Add similar level of info for AIX. PR-URL: https://github.com/nodejs/node/pull/6837 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
2016-05-27doc: update process.hrtime docs to include optional parameterdoug.wade
Adds more explicit documentation for the single optional parameter to process.hrtime to the process docs. PR-URL: https://github.com/nodejs/node/pull/6585 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
2016-05-27doc: improve server.listen() documentation proseRich Trott
PR-URL: https://github.com/nodejs/node/pull/7000 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Yuval Brik <yuval@brik.org.il> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
2016-05-27doc: improve `server.address()` doc textRich Trott
PR-URL: https://github.com/nodejs/node/pull/7001 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
2016-05-27doc: general improvements to tty.mdJames M Snell
PR-URL: https://github.com/nodejs/node/pull/6931 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2016-05-26doc: add `added: ` data for cli.mdRich Trott
PR-URL: https://github.com/nodejs/node/pull/6960 Refs: https://github.com/nodejs/node/issues/6578 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
2016-05-27doc: add `added:` information for child_processAnna Henningsen
Ref: https://github.com/nodejs/node/issues/6578 PR-URL: https://github.com/nodejs/node/pull/6927 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2016-05-26doc: general improvements to url.md copyJames M Snell
General cleanup and restructuring of the doc. Added additional detail to how URLs are serialized. PR-URL: https://github.com/nodejs/node/pull/6904 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-05-26doc: general improvements to tls.md copyJames M Snell
Restructuring and clarifications to the tls.md copy to improve readability and flow. PR-URL: https://github.com/nodejs/node/pull/6933 Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp>
2016-05-26doc: fix broken referencesAnna Henningsen
Fix minor broken references in crypto.md, net.md and domains.md (which uses `EventEmitter` as a type, of which the anchor in `events.md` has changed). PR-URL: https://github.com/nodejs/node/pull/6941 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-05-26doc: fix broken references in changelogsAnna Henningsen
Some references to a few versions were broken, likely in part due to the transition to a split changelog format. PR-URL: https://github.com/nodejs/node/pull/6942 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-05-25doc: general improvements to string_decoder.md copyJames M Snell
PR-URL: https://github.com/nodejs/node/pull/6940 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-05-24doc: remove "\" within backticksRod Machen
Ref: https://github.com/nodejs/node/issues/6911 Ref: https://github.com/nodejs/node/pull/5075 PR-URL: https://github.com/nodejs/node/pull/6952 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
2016-05-242016-05-24, Version 4.4.5 'Argon' (LTS)Myles Borins
Notable changes: * **buffer**: * Buffer no longer errors if you call lastIndexOf with a search term longer than the buffer (Anna Henningsen) https://github.com/nodejs/node/pull/6511 * contextify: * Context objects are now properly garbage collected, this solves a problem some individuals were experiencing with extreme memory growth (Ali Ijaz Sheikh) https://github.com/nodejs/node/pull/6871 * deps: * update npm to 2.15.5 (Rebecca Turner) https://github.com/nodejs/node/pull/6663 * http: * Invalid status codes can no longer be sent. Limited to 3 digit numbers between 100 - 999 (Brian White) https://github.com/nodejs/node/pull/6291
2016-05-24doc: clarify buffer classSteve Mao
Fixes: https://github.com/nodejs/node/issues/6891 PR-URL: https://github.com/nodejs/node/pull/6914 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-05-24doc: fix typos in timers topic to aid readabilityKevin Donahue
Typos in the `setTimeout` vs. `setImmediate` section were hindering readability. Fixed these typos. PR-URL: https://github.com/nodejs/node/pull/6916 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
2016-05-24doc: reference list of language-specific globalsAnna Henningsen
Fixes: https://github.com/nodejs/node/issues/6894 PR-URL: https://github.com/nodejs/node/pull/6900 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
2016-05-23doc: general improvements to util.mdJames M Snell
PR-URL: https://github.com/nodejs/node/pull/6897 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
2016-05-23doc: add `added:` information for zlibAnna Henningsen
Ref: https://github.com/nodejs/node/issues/6578 PR-URL: https://github.com/nodejs/node/pull/6840 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
2016-05-23doc: make the api doc print-friendlyMarian
Fixes: https://github.com/nodejs/node/issues/6743 PR-URL: https://github.com/nodejs/node/pull/6748 Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-13 05:50:00 +0000