Browse Source

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>
process-exit-stdio-flushing
Robert Jefe Lindstaedt 9 years ago
committed by James M Snell
parent
commit
0800c0aa72
  1. 2
      CONTRIBUTING.md
  2. 12
      Makefile
  3. 0
      doc/api/_toc.md
  4. 0
      doc/api/addons.md
  5. 0
      doc/api/all.md
  6. 0
      doc/api/assert.md
  7. 4
      doc/api/buffer.md
  8. 0
      doc/api/child_process.md
  9. 0
      doc/api/cli.md
  10. 0
      doc/api/cluster.md
  11. 2
      doc/api/console.md
  12. 0
      doc/api/crypto.md
  13. 0
      doc/api/debugger.md
  14. 0
      doc/api/dgram.md
  15. 0
      doc/api/dns.md
  16. 2
      doc/api/documentation.md
  17. 0
      doc/api/domain.md
  18. 0
      doc/api/errors.md
  19. 0
      doc/api/events.md
  20. 2
      doc/api/fs.md
  21. 2
      doc/api/globals.md
  22. 0
      doc/api/http.md
  23. 0
      doc/api/https.md
  24. 1
      doc/api/index.markdown
  25. 1
      doc/api/index.md
  26. 0
      doc/api/modules.md
  27. 0
      doc/api/net.md
  28. 0
      doc/api/os.md
  29. 0
      doc/api/path.md
  30. 24
      doc/api/process.md
  31. 0
      doc/api/punycode.md
  32. 0
      doc/api/querystring.md
  33. 0
      doc/api/readline.md
  34. 0
      doc/api/repl.md
  35. 0
      doc/api/stream.md
  36. 0
      doc/api/string_decoder.md
  37. 0
      doc/api/synopsis.md
  38. 0
      doc/api/timers.md
  39. 0
      doc/api/tls.md
  40. 0
      doc/api/tty.md
  41. 0
      doc/api/url.md
  42. 0
      doc/api/util.md
  43. 0
      doc/api/v8.md
  44. 0
      doc/api/vm.md
  45. 0
      doc/api/zlib.md
  46. 2
      src/node.cc
  47. 2
      tools/doc/README.md
  48. 2
      tools/doc/addon-verify.js
  49. 4
      tools/doc/html.js
  50. 2
      tools/doc/preprocess.js

2
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

12
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

0
doc/api/_toc.markdown → doc/api/_toc.md

0
doc/api/addons.markdown → doc/api/addons.md

0
doc/api/all.markdown → doc/api/all.md

0
doc/api/assert.markdown → doc/api/assert.md

4
doc/api/buffer.markdown → 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

0
doc/api/child_process.markdown → doc/api/child_process.md

0
doc/api/cli.markdown → doc/api/cli.md

0
doc/api/cluster.markdown → doc/api/cluster.md

2
doc/api/console.markdown → 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

0
doc/api/crypto.markdown → doc/api/crypto.md

0
doc/api/debugger.markdown → doc/api/debugger.md

0
doc/api/dgram.markdown → doc/api/dgram.md

0
doc/api/dns.markdown → doc/api/dns.md

2
doc/api/documentation.markdown → 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`.

0
doc/api/domain.markdown → doc/api/domain.md

0
doc/api/errors.markdown → doc/api/errors.md

0
doc/api/events.markdown → doc/api/events.md

2
doc/api/fs.markdown → 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

2
doc/api/globals.markdown → 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`.

0
doc/api/http.markdown → doc/api/http.md

0
doc/api/https.markdown → doc/api/https.md

1
doc/api/index.markdown

@ -1 +0,0 @@
@include _toc.markdown

1
doc/api/index.md

@ -0,0 +1 @@
@include _toc.md

0
doc/api/modules.markdown → doc/api/modules.md

0
doc/api/net.markdown → doc/api/net.md

0
doc/api/os.markdown → doc/api/os.md

0
doc/api/path.markdown → doc/api/path.md

24
doc/api/process.markdown → 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.

0
doc/api/punycode.markdown → doc/api/punycode.md

0
doc/api/querystring.markdown → doc/api/querystring.md

0
doc/api/readline.markdown → doc/api/readline.md

0
doc/api/repl.markdown → doc/api/repl.md

0
doc/api/stream.markdown → doc/api/stream.md

0
doc/api/string_decoder.markdown → doc/api/string_decoder.md

0
doc/api/synopsis.markdown → doc/api/synopsis.md

0
doc/api/timers.markdown → doc/api/timers.md

0
doc/api/tls.markdown → doc/api/tls.md

0
doc/api/tty.markdown → doc/api/tty.md

0
doc/api/url.markdown → doc/api/url.md

0
doc/api/util.markdown → doc/api/util.md

0
doc/api/v8.markdown → doc/api/v8.md

0
doc/api/vm.markdown → doc/api/vm.md

0
doc/api/zlib.markdown → doc/api/zlib.md

2
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"

2
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.

2
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();

4
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);

2
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]);

Loading…
Cancel
Save