Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Jefe Lindstaedt <robert.lindstaedt@gmail.com>2016-04-21 01:12:40 +0300
committerJames M Snell <jasnell@gmail.com>2016-04-21 02:34:27 +0300
commit0800c0aa7275bf389b157e1568fa61b59285ad86 (patch)
treea0b739491c4b0170fc333b1b57d61e6d7ae1ca58
parentcff2a137f201604cbb3c4e54578b4ebfd20bcaf2 (diff)
doc: git mv to .md
* doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: https://github.com/nodejs/node/pull/4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
-rw-r--r--CONTRIBUTING.md2
-rw-r--r--Makefile12
-rw-r--r--doc/api/_toc.md (renamed from doc/api/_toc.markdown)0
-rw-r--r--doc/api/addons.md (renamed from doc/api/addons.markdown)0
-rw-r--r--doc/api/all.md (renamed from doc/api/all.markdown)0
-rw-r--r--doc/api/assert.md (renamed from doc/api/assert.markdown)0
-rw-r--r--doc/api/buffer.md (renamed from doc/api/buffer.markdown)4
-rw-r--r--doc/api/child_process.md (renamed from doc/api/child_process.markdown)0
-rw-r--r--doc/api/cli.md (renamed from doc/api/cli.markdown)0
-rw-r--r--doc/api/cluster.md (renamed from doc/api/cluster.markdown)0
-rw-r--r--doc/api/console.md (renamed from doc/api/console.markdown)2
-rw-r--r--doc/api/crypto.md (renamed from doc/api/crypto.markdown)0
-rw-r--r--doc/api/debugger.md (renamed from doc/api/debugger.markdown)0
-rw-r--r--doc/api/dgram.md (renamed from doc/api/dgram.markdown)0
-rw-r--r--doc/api/dns.md (renamed from doc/api/dns.markdown)0
-rw-r--r--doc/api/documentation.md (renamed from doc/api/documentation.markdown)2
-rw-r--r--doc/api/domain.md (renamed from doc/api/domain.markdown)0
-rw-r--r--doc/api/errors.md (renamed from doc/api/errors.markdown)0
-rw-r--r--doc/api/events.md (renamed from doc/api/events.markdown)0
-rw-r--r--doc/api/fs.md (renamed from doc/api/fs.markdown)2
-rw-r--r--doc/api/globals.md (renamed from doc/api/globals.markdown)2
-rw-r--r--doc/api/http.md (renamed from doc/api/http.markdown)0
-rw-r--r--doc/api/https.md (renamed from doc/api/https.markdown)0
-rw-r--r--doc/api/index.markdown1
-rw-r--r--doc/api/index.md1
-rw-r--r--doc/api/modules.md (renamed from doc/api/modules.markdown)0
-rw-r--r--doc/api/net.md (renamed from doc/api/net.markdown)0
-rw-r--r--doc/api/os.md (renamed from doc/api/os.markdown)0
-rw-r--r--doc/api/path.md (renamed from doc/api/path.markdown)0
-rw-r--r--doc/api/process.md (renamed from doc/api/process.markdown)24
-rw-r--r--doc/api/punycode.md (renamed from doc/api/punycode.markdown)0
-rw-r--r--doc/api/querystring.md (renamed from doc/api/querystring.markdown)0
-rw-r--r--doc/api/readline.md (renamed from doc/api/readline.markdown)0
-rw-r--r--doc/api/repl.md (renamed from doc/api/repl.markdown)0
-rw-r--r--doc/api/stream.md (renamed from doc/api/stream.markdown)0
-rw-r--r--doc/api/string_decoder.md (renamed from doc/api/string_decoder.markdown)0
-rw-r--r--doc/api/synopsis.md (renamed from doc/api/synopsis.markdown)0
-rw-r--r--doc/api/timers.md (renamed from doc/api/timers.markdown)0
-rw-r--r--doc/api/tls.md (renamed from doc/api/tls.markdown)0
-rw-r--r--doc/api/tty.md (renamed from doc/api/tty.markdown)0
-rw-r--r--doc/api/url.md (renamed from doc/api/url.markdown)0
-rw-r--r--doc/api/util.md (renamed from doc/api/util.markdown)0
-rw-r--r--doc/api/v8.md (renamed from doc/api/v8.markdown)0
-rw-r--r--doc/api/vm.md (renamed from doc/api/vm.markdown)0
-rw-r--r--doc/api/zlib.md (renamed from doc/api/zlib.markdown)0
-rw-r--r--src/node.cc2
-rw-r--r--tools/doc/README.md2
-rw-r--r--tools/doc/addon-verify.js2
-rw-r--r--tools/doc/html.js4
-rw-r--r--tools/doc/preprocess.js2
50 files changed, 32 insertions, 32 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 842149249b4..bce91a3603c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -49,7 +49,7 @@ and built upon.
#### Respect the stability index
The rules for the master branch are less strict; consult the
-[stability index](./doc/api/documentation.markdown#stability-index) for details.
+[stability index](./doc/api/documentation..md#stability-index) for details.
In a nutshell, modules are at varying levels of API stability. Bug fixes are
always welcome but API or behavioral changes to modules at stability level 3
diff --git a/Makefile b/Makefile
index bf0c59a5f5b..b95051f994b 100644
--- a/Makefile
+++ b/Makefile
@@ -131,7 +131,7 @@ test/gc/node_modules/weak/build/Release/weakref.node: $(NODE_EXE)
--nodedir="$(shell pwd)"
# Implicitly depends on $(NODE_EXE), see the build-addons rule for rationale.
-test/addons/.docbuildstamp: doc/api/addons.markdown
+test/addons/.docbuildstamp: doc/api/addons.md
$(RM) -r test/addons/??_*/
$(NODE) tools/doc/addon-verify.js
touch $@
@@ -247,9 +247,9 @@ test-v8 test-v8-intl test-v8-benchmarks test-v8-all:
"$ git clone https://github.com/nodejs/node.git"
endif
-apidoc_sources = $(wildcard doc/api/*.markdown)
-apidocs = $(addprefix out/,$(apidoc_sources:.markdown=.html)) \
- $(addprefix out/,$(apidoc_sources:.markdown=.json))
+apidoc_sources = $(wildcard doc/api/*.md)
+apidocs = $(addprefix out/,$(apidoc_sources:.md=.html)) \
+ $(addprefix out/,$(apidoc_sources:.md=.json))
apidoc_dirs = out/doc out/doc/api/ out/doc/api/assets
@@ -266,10 +266,10 @@ out/doc/api/assets/%: doc/api_assets/% out/doc/api/assets/
out/doc/%: doc/%
cp -r $< $@
-out/doc/api/%.json: doc/api/%.markdown $(NODE_EXE)
+out/doc/api/%.json: doc/api/%.md $(NODE_EXE)
$(NODE) tools/doc/generate.js --format=json $< > $@
-out/doc/api/%.html: doc/api/%.markdown $(NODE_EXE)
+out/doc/api/%.html: doc/api/%.md $(NODE_EXE)
$(NODE) tools/doc/generate.js --format=html --template=doc/template.html $< > $@
docopen: out/doc/api/all.html
diff --git a/doc/api/_toc.markdown b/doc/api/_toc.md
index 5c8fbdd7901..5c8fbdd7901 100644
--- a/doc/api/_toc.markdown
+++ b/doc/api/_toc.md
diff --git a/doc/api/addons.markdown b/doc/api/addons.md
index 4668bc546f2..4668bc546f2 100644
--- a/doc/api/addons.markdown
+++ b/doc/api/addons.md
diff --git a/doc/api/all.markdown b/doc/api/all.md
index 93c7a300a16..93c7a300a16 100644
--- a/doc/api/all.markdown
+++ b/doc/api/all.md
diff --git a/doc/api/assert.markdown b/doc/api/assert.md
index 35dbc3d2192..35dbc3d2192 100644
--- a/doc/api/assert.markdown
+++ b/doc/api/assert.md
diff --git a/doc/api/buffer.markdown b/doc/api/buffer.md
index ecf9f792b3b..b367b8bed52 100644
--- a/doc/api/buffer.markdown
+++ b/doc/api/buffer.md
@@ -764,8 +764,8 @@ console.log(buf2.compare(buf3));
// produces sort order [buf1, buf3, buf2]
```
-The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd`
-arguments can be used to limit the comparison to specific ranges within the two
+The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd`
+arguments can be used to limit the comparison to specific ranges within the two
`Buffer` objects.
```js
diff --git a/doc/api/child_process.markdown b/doc/api/child_process.md
index 2c8665be58f..2c8665be58f 100644
--- a/doc/api/child_process.markdown
+++ b/doc/api/child_process.md
diff --git a/doc/api/cli.markdown b/doc/api/cli.md
index e03773d1e71..e03773d1e71 100644
--- a/doc/api/cli.markdown
+++ b/doc/api/cli.md
diff --git a/doc/api/cluster.markdown b/doc/api/cluster.md
index 8937aa91287..8937aa91287 100644
--- a/doc/api/cluster.markdown
+++ b/doc/api/cluster.md
diff --git a/doc/api/console.markdown b/doc/api/console.md
index 32dab8e7171..655e64c5ac9 100644
--- a/doc/api/console.markdown
+++ b/doc/api/console.md
@@ -110,7 +110,7 @@ console.assert(false, 'Whoops %s', 'didn\'t work');
```
*Note: the `console.assert()` method is implemented differently in Node.js
-than the `console.assert()` method [available in browsers][web-api-assert].*
+than the `console.assert()` method [available in browsers][web-api-assert].*
Specifically, in browsers, calling `console.assert()` with a falsy
assertion will cause the `message` to be printed to the console without
diff --git a/doc/api/crypto.markdown b/doc/api/crypto.md
index 14adffd8d8e..14adffd8d8e 100644
--- a/doc/api/crypto.markdown
+++ b/doc/api/crypto.md
diff --git a/doc/api/debugger.markdown b/doc/api/debugger.md
index 400192ee00c..400192ee00c 100644
--- a/doc/api/debugger.markdown
+++ b/doc/api/debugger.md
diff --git a/doc/api/dgram.markdown b/doc/api/dgram.md
index 1bb5155578d..1bb5155578d 100644
--- a/doc/api/dgram.markdown
+++ b/doc/api/dgram.md
diff --git a/doc/api/dns.markdown b/doc/api/dns.md
index 13dee0a6cb4..13dee0a6cb4 100644
--- a/doc/api/dns.markdown
+++ b/doc/api/dns.md
diff --git a/doc/api/documentation.markdown b/doc/api/documentation.md
index 4d357e39efa..e39dc8f0016 100644
--- a/doc/api/documentation.markdown
+++ b/doc/api/documentation.md
@@ -16,7 +16,7 @@ experimental, and added for the benefit of IDEs and other utilities that
wish to do programmatic things with the documentation.
Every `.html` and `.json` file is generated based on the corresponding
-`.markdown` file in the `doc/api/` folder in Node.js's source tree. The
+`.md` file in the `doc/api/` folder in Node.js's source tree. The
documentation is generated using the `tools/doc/generate.js` program.
The HTML template is located at `doc/template.html`.
diff --git a/doc/api/domain.markdown b/doc/api/domain.md
index c556e2533c0..c556e2533c0 100644
--- a/doc/api/domain.markdown
+++ b/doc/api/domain.md
diff --git a/doc/api/errors.markdown b/doc/api/errors.md
index bb83ef1320a..bb83ef1320a 100644
--- a/doc/api/errors.markdown
+++ b/doc/api/errors.md
diff --git a/doc/api/events.markdown b/doc/api/events.md
index 393a69ee02a..393a69ee02a 100644
--- a/doc/api/events.markdown
+++ b/doc/api/events.md
diff --git a/doc/api/fs.markdown b/doc/api/fs.md
index 22eb14c9dab..4364b1cc5cc 100644
--- a/doc/api/fs.markdown
+++ b/doc/api/fs.md
@@ -103,7 +103,7 @@ uses, working with paths as Buffers will be unnecessary, as the string
API converts to and from UTF-8 automatically.
*Note* that on certain file systems (such as NTFS and HFS+) filenames
-will always be encoded as UTF-8. On such file systems, passing
+will always be encoded as UTF-8. On such file systems, passing
non-UTF-8 encoded Buffers to `fs` functions will not work as expected.
## Class: fs.FSWatcher
diff --git a/doc/api/globals.markdown b/doc/api/globals.md
index a43d28eccb9..643ab4334b2 100644
--- a/doc/api/globals.markdown
+++ b/doc/api/globals.md
@@ -36,7 +36,7 @@ For instance, given two modules: `a` and `b`, where `b` is a dependency of
* `/Users/mjr/app/a.js`
* `/Users/mjr/app/node_modules/b/b.js`
-References to `__dirname` within `b.js` will return
+References to `__dirname` within `b.js` will return
`/Users/mjr/app/node_modules/b` while references to `__dirname` within `a.js`
will return `/Users/mj/app`.
diff --git a/doc/api/http.markdown b/doc/api/http.md
index 68f0bd6d735..68f0bd6d735 100644
--- a/doc/api/http.markdown
+++ b/doc/api/http.md
diff --git a/doc/api/https.markdown b/doc/api/https.md
index 69b5f418466..69b5f418466 100644
--- a/doc/api/https.markdown
+++ b/doc/api/https.md
diff --git a/doc/api/index.markdown b/doc/api/index.markdown
deleted file mode 100644
index 1a774507aef..00000000000
--- a/doc/api/index.markdown
+++ /dev/null
@@ -1 +0,0 @@
-@include _toc.markdown
diff --git a/doc/api/index.md b/doc/api/index.md
new file mode 100644
index 00000000000..400faf6e5ed
--- /dev/null
+++ b/doc/api/index.md
@@ -0,0 +1 @@
+@include _toc.md
diff --git a/doc/api/modules.markdown b/doc/api/modules.md
index 20c8b175cd9..20c8b175cd9 100644
--- a/doc/api/modules.markdown
+++ b/doc/api/modules.md
diff --git a/doc/api/net.markdown b/doc/api/net.md
index 7a58bf23108..7a58bf23108 100644
--- a/doc/api/net.markdown
+++ b/doc/api/net.md
diff --git a/doc/api/os.markdown b/doc/api/os.md
index 43e71460c24..43e71460c24 100644
--- a/doc/api/os.markdown
+++ b/doc/api/os.md
diff --git a/doc/api/path.markdown b/doc/api/path.md
index 49cff7a8beb..49cff7a8beb 100644
--- a/doc/api/path.markdown
+++ b/doc/api/path.md
diff --git a/doc/api/process.markdown b/doc/api/process.md
index 841984a1e9f..a67752878b2 100644
--- a/doc/api/process.markdown
+++ b/doc/api/process.md
@@ -7,12 +7,12 @@ It is an instance of [`EventEmitter`][].
## Event: 'beforeExit'
-This event is emitted when Node.js empties its event loop and has nothing else
-to schedule. Normally, Node.js exits when there is no work scheduled, but a
-listener for `'beforeExit'` can make asynchronous calls, and cause Node.js to
+This event is emitted when Node.js empties its event loop and has nothing else
+to schedule. Normally, Node.js exits when there is no work scheduled, but a
+listener for `'beforeExit'` can make asynchronous calls, and cause Node.js to
continue.
-`'beforeExit'` is not emitted for conditions causing explicit termination, such
+`'beforeExit'` is not emitted for conditions causing explicit termination, such
as [`process.exit()`][] or uncaught exceptions, and should not be used as an
alternative to the `'exit'` event unless the intention is to schedule more work.
@@ -93,7 +93,7 @@ indefinitely) or upon process exit (more convenient for scripts).
## Event: 'uncaughtException'
The `'uncaughtException'` event is emitted when an exception bubbles all the
-way back to the event loop. By default, Node.js handles such exceptions by
+way back to the event loop. By default, Node.js handles such exceptions by
printing the stack trace to stderr and exiting. Adding a handler for the
`'uncaughtException'` event overrides this default behavior.
@@ -145,7 +145,7 @@ a promise chain. This event is useful for detecting and keeping track of
promises that were rejected whose rejections were not handled yet. This event
is emitted with the following arguments:
- - `reason` the object with which the promise was rejected (usually an
+ - `reason` the object with which the promise was rejected (usually an
[`Error`][] instance).
- `p` the promise that was rejected.
@@ -371,9 +371,9 @@ Note:
- `SIGUSR1` is reserved by Node.js to start the debugger. It's possible to
install a listener but that won't stop the debugger from starting.
-- `SIGTERM` and `SIGINT` have default handlers on non-Windows platforms that
- resets the terminal mode before exiting with code `128 + signal number`. If
- one of these signals has a listener installed, its default behavior will be
+- `SIGTERM` and `SIGINT` have default handlers on non-Windows platforms that
+ resets the terminal mode before exiting with code `128 + signal number`. If
+ one of these signals has a listener installed, its default behavior will be
removed (Node.js will no longer exit).
- `SIGPIPE` is ignored by default. It can have a listener installed.
- `SIGHUP` is generated on Windows when the console window is closed, and on other
@@ -386,11 +386,11 @@ Note:
- `SIGINT` from the terminal is supported on all platforms, and can usually be
generated with `CTRL+C` (though this may be configurable). It is not generated
when terminal raw mode is enabled.
-- `SIGBREAK` is delivered on Windows when `CTRL+BREAK` is pressed, on
+- `SIGBREAK` is delivered on Windows when `CTRL+BREAK` is pressed, on
non-Windows
platforms it can be listened on, but there is no way to send or generate it.
-- `SIGWINCH` is delivered when the console has been resized. On Windows, this
- will only happen on write to the console when the cursor is being moved, or
+- `SIGWINCH` is delivered when the console has been resized. On Windows, this
+ will only happen on write to the console when the cursor is being moved, or
when a readable tty is used in raw mode.
- `SIGKILL` cannot have a listener installed, it will unconditionally terminate
Node.js on all platforms.
diff --git a/doc/api/punycode.markdown b/doc/api/punycode.md
index 7f3617c12d8..7f3617c12d8 100644
--- a/doc/api/punycode.markdown
+++ b/doc/api/punycode.md
diff --git a/doc/api/querystring.markdown b/doc/api/querystring.md
index 3a864e2d4fa..3a864e2d4fa 100644
--- a/doc/api/querystring.markdown
+++ b/doc/api/querystring.md
diff --git a/doc/api/readline.markdown b/doc/api/readline.md
index db543d2306a..db543d2306a 100644
--- a/doc/api/readline.markdown
+++ b/doc/api/readline.md
diff --git a/doc/api/repl.markdown b/doc/api/repl.md
index f77833ea472..f77833ea472 100644
--- a/doc/api/repl.markdown
+++ b/doc/api/repl.md
diff --git a/doc/api/stream.markdown b/doc/api/stream.md
index d2d0c4487ed..d2d0c4487ed 100644
--- a/doc/api/stream.markdown
+++ b/doc/api/stream.md
diff --git a/doc/api/string_decoder.markdown b/doc/api/string_decoder.md
index d1de27dc4a3..d1de27dc4a3 100644
--- a/doc/api/string_decoder.markdown
+++ b/doc/api/string_decoder.md
diff --git a/doc/api/synopsis.markdown b/doc/api/synopsis.md
index 7dd3b8fe99d..7dd3b8fe99d 100644
--- a/doc/api/synopsis.markdown
+++ b/doc/api/synopsis.md
diff --git a/doc/api/timers.markdown b/doc/api/timers.md
index d33bf1dc22b..d33bf1dc22b 100644
--- a/doc/api/timers.markdown
+++ b/doc/api/timers.md
diff --git a/doc/api/tls.markdown b/doc/api/tls.md
index ae324f8852e..ae324f8852e 100644
--- a/doc/api/tls.markdown
+++ b/doc/api/tls.md
diff --git a/doc/api/tty.markdown b/doc/api/tty.md
index 770990a8dee..770990a8dee 100644
--- a/doc/api/tty.markdown
+++ b/doc/api/tty.md
diff --git a/doc/api/url.markdown b/doc/api/url.md
index ab29c500d80..ab29c500d80 100644
--- a/doc/api/url.markdown
+++ b/doc/api/url.md
diff --git a/doc/api/util.markdown b/doc/api/util.md
index c059be8c0dd..c059be8c0dd 100644
--- a/doc/api/util.markdown
+++ b/doc/api/util.md
diff --git a/doc/api/v8.markdown b/doc/api/v8.md
index 4761355141d..4761355141d 100644
--- a/doc/api/v8.markdown
+++ b/doc/api/v8.md
diff --git a/doc/api/vm.markdown b/doc/api/vm.md
index e4a142e930e..e4a142e930e 100644
--- a/doc/api/vm.markdown
+++ b/doc/api/vm.md
diff --git a/doc/api/zlib.markdown b/doc/api/zlib.md
index fa3f8ee2158..fa3f8ee2158 100644
--- a/doc/api/zlib.markdown
+++ b/doc/api/zlib.md
diff --git a/src/node.cc b/src/node.cc
index c36161e7ff0..e7836fe0a6b 100644
--- a/src/node.cc
+++ b/src/node.cc
@@ -3376,7 +3376,7 @@ static bool ParseDebugOpt(const char* arg) {
static void PrintHelp() {
// XXX: If you add an option here, please also add it to doc/node.1 and
- // doc/api/cli.markdown
+ // doc/api/cli.md
printf("Usage: node [options] [ -e script | script.js ] [arguments] \n"
" node debug script.js [arguments] \n"
"\n"
diff --git a/tools/doc/README.md b/tools/doc/README.md
index 0e8d48fbcb5..fd041f001e6 100644
--- a/tools/doc/README.md
+++ b/tools/doc/README.md
@@ -1,6 +1,6 @@
Here's how the node docs work.
-1:1 relationship from `lib/<module>.js` to `doc/api/<module>.markdown`
+1:1 relationship from `lib/<module>.js` to `doc/api/<module>.md`
Each type of heading has a description block.
diff --git a/tools/doc/addon-verify.js b/tools/doc/addon-verify.js
index 5ff12d342c7..a6dca436383 100644
--- a/tools/doc/addon-verify.js
+++ b/tools/doc/addon-verify.js
@@ -5,7 +5,7 @@ const path = require('path');
const marked = require('marked');
const rootDir = path.resolve(__dirname, '..', '..');
-const doc = path.resolve(rootDir, 'doc', 'api', 'addons.markdown');
+const doc = path.resolve(rootDir, 'doc', 'api', 'addons.md');
const verifyDir = path.resolve(rootDir, 'test', 'addons');
const contents = fs.readFileSync(doc).toString();
diff --git a/tools/doc/html.js b/tools/doc/html.js
index feb99cd8104..99a8cbf21a0 100644
--- a/tools/doc/html.js
+++ b/tools/doc/html.js
@@ -15,7 +15,7 @@ var gtocPath = path.resolve(path.join(
'..',
'doc',
'api',
- '_toc.markdown'
+ '_toc.md'
));
var gtocLoading = null;
var gtocData = null;
@@ -75,7 +75,7 @@ function render(lexed, filename, template, cb) {
// get the section
var section = getSection(lexed);
- filename = path.basename(filename, '.markdown');
+ filename = path.basename(filename, '.md');
parseText(lexed);
lexed = parseLists(lexed);
diff --git a/tools/doc/preprocess.js b/tools/doc/preprocess.js
index 8f802714bcb..295737a2a53 100644
--- a/tools/doc/preprocess.js
+++ b/tools/doc/preprocess.js
@@ -30,7 +30,7 @@ function processIncludes(inputFile, input, cb) {
if (incCount === 0) cb(null, input);
includes.forEach(function(include) {
var fname = include.replace(/^@include\s+/, '');
- if (!fname.match(/\.markdown$/)) fname += '.markdown';
+ if (!fname.match(/\.md$/)) fname += '.md';
if (includeData.hasOwnProperty(fname)) {
input = input.split(include).join(includeData[fname]);