summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2012-05-04 15:12:47 -0700
committerisaacs <i@izs.me>2012-05-04 15:12:47 -0700
commit01d146c29f318fb3dce485e49c2541f53dc4a952 (patch)
treec659dc29764875d840e8cf6d9c194fac513a91c5 /doc
parent1de43149bbb8c42b80cef4c25509390f3b4000cc (diff)
parent992e3464b8997210ea7f40f03f0386f8dd4f4f86 (diff)
downloadnode-new-01d146c29f318fb3dce485e49c2541f53dc4a952.tar.gz
Merge remote-tracking branch 'ry/v0.6' into v0.6-merge
Conflicts: ChangeLog Makefile deps/npm/AUTHORS deps/npm/html/api/bin.html deps/npm/html/api/bugs.html deps/npm/html/api/commands.html deps/npm/html/api/config.html deps/npm/html/api/deprecate.html deps/npm/html/api/docs.html deps/npm/html/api/edit.html deps/npm/html/api/explore.html deps/npm/html/api/help-search.html deps/npm/html/api/init.html deps/npm/html/api/install.html deps/npm/html/api/link.html deps/npm/html/api/load.html deps/npm/html/api/ls.html deps/npm/html/api/npm.html deps/npm/html/api/outdated.html deps/npm/html/api/owner.html deps/npm/html/api/pack.html deps/npm/html/api/prefix.html deps/npm/html/api/prune.html deps/npm/html/api/publish.html deps/npm/html/api/rebuild.html deps/npm/html/api/restart.html deps/npm/html/api/root.html deps/npm/html/api/run-script.html deps/npm/html/api/search.html deps/npm/html/api/shrinkwrap.html deps/npm/html/api/start.html deps/npm/html/api/stop.html deps/npm/html/api/submodule.html deps/npm/html/api/tag.html deps/npm/html/api/test.html deps/npm/html/api/uninstall.html deps/npm/html/api/unpublish.html deps/npm/html/api/update.html deps/npm/html/api/version.html deps/npm/html/api/view.html deps/npm/html/api/whoami.html deps/npm/html/doc/README.html deps/npm/html/doc/adduser.html deps/npm/html/doc/bin.html deps/npm/html/doc/bugs.html deps/npm/html/doc/build.html deps/npm/html/doc/bundle.html deps/npm/html/doc/cache.html deps/npm/html/doc/changelog.html deps/npm/html/doc/coding-style.html deps/npm/html/doc/completion.html deps/npm/html/doc/config.html deps/npm/html/doc/deprecate.html deps/npm/html/doc/developers.html deps/npm/html/doc/disputes.html deps/npm/html/doc/docs.html deps/npm/html/doc/edit.html deps/npm/html/doc/explore.html deps/npm/html/doc/faq.html deps/npm/html/doc/folders.html deps/npm/html/doc/help-search.html deps/npm/html/doc/help.html deps/npm/html/doc/index.html deps/npm/html/doc/init.html deps/npm/html/doc/install.html deps/npm/html/doc/json.html deps/npm/html/doc/link.html deps/npm/html/doc/list.html deps/npm/html/doc/npm.html deps/npm/html/doc/outdated.html deps/npm/html/doc/owner.html deps/npm/html/doc/pack.html deps/npm/html/doc/prefix.html deps/npm/html/doc/prune.html deps/npm/html/doc/publish.html deps/npm/html/doc/rebuild.html deps/npm/html/doc/registry.html deps/npm/html/doc/removing-npm.html deps/npm/html/doc/restart.html deps/npm/html/doc/root.html deps/npm/html/doc/run-script.html deps/npm/html/doc/scripts.html deps/npm/html/doc/search.html deps/npm/html/doc/semver.html deps/npm/html/doc/shrinkwrap.html deps/npm/html/doc/star.html deps/npm/html/doc/start.html deps/npm/html/doc/stop.html deps/npm/html/doc/submodule.html deps/npm/html/doc/tag.html deps/npm/html/doc/test.html deps/npm/html/doc/uninstall.html deps/npm/html/doc/unpublish.html deps/npm/html/doc/update.html deps/npm/html/doc/version.html deps/npm/html/doc/view.html deps/npm/html/doc/whoami.html deps/npm/man/man1/npm.1 deps/npm/man/man3/npm.3 deps/npm/package.json doc/api/url.markdown lib/http.js src/node_version.h test/simple/test-fs-sync-fd-leak.js
Diffstat (limited to 'doc')
-rw-r--r--doc/api/child_process.markdown4
-rw-r--r--doc/api/url.markdown55
2 files changed, 38 insertions, 21 deletions
diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown
index 4dc156255b..c8a1c64c6c 100644
--- a/doc/api/child_process.markdown
+++ b/doc/api/child_process.markdown
@@ -250,7 +250,7 @@ See also: `child_process.exec()` and `child_process.fork()`
* `maxBuffer` {Number} (Default: 200*1024)
* `killSignal` {String} (Default: 'SIGTERM')
* `callback` {Function} called with the output when process terminates
- * `code` {Integer} Exit code
+ * `error` {Error}
* `stdout` {Buffer}
* `stderr` {Buffer}
* Return: ChildProcess object
@@ -307,7 +307,7 @@ the child process is killed.
* `maxBuffer` {Number} (Default: 200*1024)
* `killSignal` {String} (Default: 'SIGTERM')
* `callback` {Function} called with the output when process terminates
- * `code` {Integer} Exit code
+ * `error` {Error}
* `stdout` {Buffer}
* `stderr` {Buffer}
* Return: ChildProcess object
diff --git a/doc/api/url.markdown b/doc/api/url.markdown
index 7eb417dbdd..8e6a63d3bb 100644
--- a/doc/api/url.markdown
+++ b/doc/api/url.markdown
@@ -13,37 +13,51 @@ string will not be in the parsed object. Examples are shown for the URL
* `href`: The full URL that was originally parsed. Both the protocol and host are lowercased.
- Example: `'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'`
+ Example: `'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'`
+
* `protocol`: The request protocol, lowercased.
- Example: `'http:'`
-* `host`: The full lowercased host portion of the URL, including the port.
+ Example: `'http:'`
+
+* `host`: The full lowercased host portion of the URL, including port
+ information.
+
+ Example: `'host.com:8080'`
- Example: `'host.com:8080'`
* `auth`: The authentication information portion of a URL.
- Example: `'user:pass'`
+ Example: `'user:pass'`
+
* `hostname`: Just the lowercased hostname portion of the host.
- Example: `'host.com'`
+ Example: `'host.com'`
+
* `port`: The port number portion of the host.
- Example: `'8080'`
-* `pathname`: The path section of the URL, that comes after the host and before the query, including the initial slash if present.
+ Example: `'8080'`
- Example: `'/p/a/t/h'`
-* `search`: The 'query string' portion of the URL, including the leading question mark.
+* `pathname`: The path section of the URL, that comes after the host and
+ before the query, including the initial slash if present.
+
+ Example: `'/p/a/t/h'`
+
+* `search`: The 'query string' portion of the URL, including the leading
+ question mark.
+
+ Example: `'?query=string'`
- Example: `'?query=string'`
* `path`: Concatenation of `pathname` and `search`.
- Example: `'/p/a/t/h?query=string'`
-* `query`: Either the 'params' portion of the query string, or a querystring-parsed object.
+ Example: `'/p/a/t/h?query=string'`
+
+* `query`: Either the 'params' portion of the query string, or a
+ querystring-parsed object.
+
+ Example: `'query=string'` or `{'query':'string'}`
- Example: `'query=string'` or `{'query':'string'}`
* `hash`: The 'fragment' portion of the URL including the pound-sign.
- Example: `'#hash'`
+ Example: `'#hash'`
The following methods are provided by the URL module:
@@ -65,9 +79,11 @@ Take a parsed URL object, and return a formatted URL string.
* `href` will be ignored.
* `protocol`is treated the same with or without the trailing `:` (colon).
- * The protocols `http`, `https`, `ftp`, `gopher`, `file` will be postfixed with `://` (colon-slash-slash).
- * All other protocols `mailto`, `xmpp`, `aim`, `sftp`, `foo`, etc will be postfixed with `:` (colon)
-* `auth` will only be used if `host` is absent.
+ * The protocols `http`, `https`, `ftp`, `gopher`, `file` will be
+ postfixed with `://` (colon-slash-slash).
+ * All other protocols `mailto`, `xmpp`, `aim`, `sftp`, `foo`, etc will
+ be postfixed with `:` (colon)
+* `auth` will be used if present.
* `hostname` will only be used if `host` is absent.
* `port` will only be used if `host` is absent.
* `host` will be used in place of `hostname` and `port`
@@ -79,4 +95,5 @@ Take a parsed URL object, and return a formatted URL string.
## url.resolve(from, to)
-Take a base URL, and a href URL, and resolve them as a browser would for an anchor tag.
+Take a base URL, and a href URL, and resolve them as a browser would for
+an anchor tag.