Skip to content

Commit

Permalink
build: make doc target quiet
Browse files Browse the repository at this point in the history
Currently it can be a little difficult to detect errors in the output
from the doc target. This commit suggests reducing the output to make it
easier to identify errors.

PR-URL: #16516
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
  • Loading branch information
danbev authored and gibfahn committed Oct 30, 2017
1 parent bc2364d commit 67f769b
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 7 deletions.
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -542,13 +542,13 @@ doc-only: $(apidocs_html) $(apidocs_json)
doc: $(NODE_EXE) doc-only

$(apidoc_dirs):
mkdir -p $@
@mkdir -p $@

out/doc/api/assets/%: doc/api_assets/% out/doc/api/assets
cp $< $@
@cp $< $@

out/doc/%: doc/%
cp -r $< $@
@cp -r $< $@

# check if ./node is actually set, else use user pre-installed binary
gen-json = tools/doc/generate.js --format=json $< > $@
Expand All @@ -566,11 +566,11 @@ gen-doc = \
[ -x $(NODE) ] && $(NODE) $(1) || node $(1)

out/doc/api/%.json: doc/api/%.md
$(call gen-doc, $(gen-json))
@$(call gen-doc, $(gen-json))

# check if ./node is actually set, else use user pre-installed binary
out/doc/api/%.html: doc/api/%.md
$(call gen-doc, $(gen-html))
@$(call gen-doc, $(gen-html))

docopen: $(apidocs_html)
@$(PYTHON) -mwebbrowser file://$(PWD)/out/doc/api/all.html
Expand Down
1 change: 0 additions & 1 deletion tools/doc/generate.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ if (!inputFile) {
throw new Error('No input file specified');
}

console.error('Input file = %s', inputFile);
fs.readFile(inputFile, 'utf8', function(er, input) {
if (er) throw er;
// process the input for @include lines
Expand Down
1 change: 0 additions & 1 deletion tools/doc/preprocess.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ function processIncludes(inputFile, input, cb) {
const includes = input.match(includeExpr);
if (includes === null) return cb(null, input);
var errState = null;
console.error(includes);
var incCount = includes.length;
if (incCount === 0) cb(null, input);
includes.forEach(function(include) {
Expand Down

0 comments on commit 67f769b

Please sign in to comment.