Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 101dd1e

Browse filesBrowse files
jmmMyles Borins
jmm
authored and
Myles Borins
committed
build: add Make doc-only target
Allows building just docs using existing Node instead of building Node first. PR-URL: #3888 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
1 parent 4f925dd commit 101dd1e
Copy full SHA for 101dd1e

File tree

Expand file treeCollapse file tree

4 files changed

+49
-15
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

4 files changed

+49
-15
lines changed
Open diff view settings
Collapse file

‎BUILDING.md‎

Copy file name to clipboardExpand all lines: BUILDING.md
+10Lines changed: 10 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,20 @@ $ make test-npm
6767

6868
To build the documentation:
6969

70+
This will build Node.js first (if necessary) and then use it to build the docs:
71+
7072
```text
7173
$ make doc
7274
```
7375

76+
If you have an existing Node.js you can build just the docs with:
77+
78+
```text
79+
$ NODE=node make doc-only
80+
```
81+
82+
(Where `node` is the path to your executable.)
83+
7484
To read the documentation:
7585

7686
```text
Collapse file

‎Makefile‎

Copy file name to clipboardExpand all lines: Makefile
+8-6Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ BUILDTYPE_LOWER := $(shell echo $(BUILDTYPE) | tr '[A-Z]' '[a-z]')
3636
EXEEXT := $(shell $(PYTHON) -c \
3737
"import sys; print('.exe' if sys.platform == 'win32' else '')")
3838

39-
NODE ?= ./node$(EXEEXT)
4039
NODE_EXE = node$(EXEEXT)
40+
NODE ?= ./$(NODE_EXE)
4141
NODE_G_EXE = node_g$(EXEEXT)
4242

4343
# Flags for packaging.
@@ -258,7 +258,9 @@ apidoc_dirs = out/doc out/doc/api/ out/doc/api/assets
258258

259259
apiassets = $(subst api_assets,api/assets,$(addprefix out/,$(wildcard doc/api_assets/*)))
260260

261-
doc: $(apidoc_dirs) $(apiassets) $(apidocs) tools/doc/ $(NODE_EXE)
261+
doc-only: $(apidoc_dirs) $(apiassets) $(apidocs) tools/doc/
262+
263+
doc: $(NODE_EXE) doc-only
262264

263265
$(apidoc_dirs):
264266
mkdir -p $@
@@ -269,11 +271,11 @@ out/doc/api/assets/%: doc/api_assets/% out/doc/api/assets/
269271
out/doc/%: doc/%
270272
cp -r $< $@
271273

272-
out/doc/api/%.json: doc/api/%.md $(NODE_EXE)
274+
out/doc/api/%.json: doc/api/%.md
273275
$(NODE) tools/doc/generate.js --format=json $< > $@
274276

275-
out/doc/api/%.html: doc/api/%.md $(NODE_EXE)
276-
$(NODE) tools/doc/generate.js --format=html --template=doc/template.html $< > $@
277+
out/doc/api/%.html: doc/api/%.md
278+
$(NODE) tools/doc/generate.js --node-version=$(FULLVERSION) --format=html --template=doc/template.html $< > $@
277279

278280
docopen: out/doc/api/all.html
279281
-google-chrome out/doc/api/all.html
@@ -663,5 +665,5 @@ endif
663665
blog blogclean tar binary release-only bench-http-simple bench-idle \
664666
bench-all bench bench-misc bench-array bench-buffer bench-net \
665667
bench-http bench-fs bench-tls cctest run-ci test-v8 test-v8-intl \
666-
test-v8-benchmarks test-v8-all v8 lint-ci bench-ci jslint-ci \
668+
test-v8-benchmarks test-v8-all v8 lint-ci bench-ci jslint-ci doc-only \
667669
$(TARBALL)-headers
Collapse file

‎tools/doc/generate.js‎

Copy file name to clipboardExpand all lines: tools/doc/generate.js
+9-4Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ const args = process.argv.slice(2);
1010
let format = 'json';
1111
let template = null;
1212
let inputFile = null;
13+
let nodeVersion = null;
1314

1415
args.forEach(function(arg) {
1516
if (!arg.match(/^\-\-/)) {
@@ -18,23 +19,22 @@ args.forEach(function(arg) {
1819
format = arg.replace(/^\-\-format=/, '');
1920
} else if (arg.match(/^\-\-template=/)) {
2021
template = arg.replace(/^\-\-template=/, '');
22+
} else if (arg.match(/^\-\-node\-version=/)) {
23+
nodeVersion = arg.replace(/^\-\-node\-version=/, '');
2124
}
2225
});
2326

24-
2527
if (!inputFile) {
2628
throw new Error('No input file specified');
2729
}
2830

29-
3031
console.error('Input file = %s', inputFile);
3132
fs.readFile(inputFile, 'utf8', function(er, input) {
3233
if (er) throw er;
3334
// process the input for @include lines
3435
processIncludes(inputFile, input, next);
3536
});
3637

37-
3838
function next(er, input) {
3939
if (er) throw er;
4040
switch (format) {
@@ -46,7 +46,12 @@ function next(er, input) {
4646
break;
4747

4848
case 'html':
49-
require('./html.js')(input, inputFile, template, function(er, html) {
49+
require('./html.js')({
50+
input: input,
51+
filename: inputFile,
52+
template: template,
53+
nodeVersion: nodeVersion,
54+
}, function(er, html) {
5055
if (er) throw er;
5156
console.log(html);
5257
});
Collapse file

‎tools/doc/html.js‎

Copy file name to clipboardExpand all lines: tools/doc/html.js
+22-5Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,12 @@ var gtocPath = path.resolve(path.join(
3030
var gtocLoading = null;
3131
var gtocData = null;
3232

33-
function toHTML(input, filename, template, cb) {
33+
/**
34+
* opts: input, filename, template, nodeVersion.
35+
*/
36+
function toHTML(opts, cb) {
37+
var template = opts.template;
38+
3439
if (gtocData) {
3540
return onGtocLoaded();
3641
}
@@ -51,10 +56,15 @@ function toHTML(input, filename, template, cb) {
5156
}
5257

5358
function onGtocLoaded() {
54-
var lexed = marked.lexer(input);
59+
var lexed = marked.lexer(opts.input);
5560
fs.readFile(template, 'utf8', function(er, template) {
5661
if (er) return cb(er);
57-
render(lexed, filename, template, cb);
62+
render({
63+
lexed: lexed,
64+
filename: opts.filename,
65+
template: template,
66+
nodeVersion: opts.nodeVersion,
67+
}, cb);
5868
});
5969
}
6070
}
@@ -81,7 +91,14 @@ function toID(filename) {
8191
.replace(/-+/g, '-');
8292
}
8393

84-
function render(lexed, filename, template, cb) {
94+
/**
95+
* opts: lexed, filename, template, nodeVersion.
96+
*/
97+
function render(opts, cb) {
98+
var lexed = opts.lexed;
99+
var filename = opts.filename;
100+
var template = opts.template;
101+
85102
// get the section
86103
var section = getSection(lexed);
87104

@@ -100,7 +117,7 @@ function render(lexed, filename, template, cb) {
100117
template = template.replace(/__ID__/g, id);
101118
template = template.replace(/__FILENAME__/g, filename);
102119
template = template.replace(/__SECTION__/g, section);
103-
template = template.replace(/__VERSION__/g, process.version);
120+
template = template.replace(/__VERSION__/g, opts.nodeVersion);
104121
template = template.replace(/__TOC__/g, toc);
105122
template = template.replace(
106123
/__GTOC__/g,

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.