Skip to content

build: reduce noise from doc target - #9457

Closed
danbev wants to merge 1 commit into
nodejs:masterfrom
danbev:reduce-noice-of-doc-target
Closed

build: reduce noise from doc target#9457
danbev wants to merge 1 commit into
nodejs:masterfrom
danbev:reduce-noice-of-doc-target

Conversation

@danbev

Copy link
Copy Markdown
Contributor
Checklist
  • make -j8 test (UNIX), or vcbuild test nosign (Windows) passes
  • commit message follows commit guidelines
Affected core subsystem(s)

build

Description of change

The doc target currently echos the complete shell command, which might
produces a lot of output. Using this change the actual commands run
are still shown.

Before:

[ -e tools/doc/node_modules/js-yaml/package.json ] || \
[ -e tools/eslint/node_modules/js-yaml/package.json ] || \
if [ -x ./node ];then \
cd tools/doc && ../.././node ../.././deps/npm/bin/npm-cli.js
install; \
else \
cd tools/doc && node ../.././deps/npm/bin/npm-cli.js
install; \
fi
[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md

After:

[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md

To verify run:

$ make docclean
$ make doc

The doc target currently echos the complete shell command, which might
produces a lot of output. Using this change the actual commands run
are still shown.
Before:
[ -e tools/doc/node_modules/js-yaml/package.json ] || \
[ -e tools/eslint/node_modules/js-yaml/package.json ] || \
if [ -x ./node ]; then \
cd tools/doc && ../.././node ../.././deps/npm/bin/npm-cli.js
install; \
else \
cd tools/doc && node ../.././deps/npm/bin/npm-cli.js
install; \
fi
[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md
After:
[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md
To verify run:
$ make docclean
$ make doc
@nodejs-github-botnodejs-github-bot added the build Issues and PRs related to build files or the CI. label Nov 4, 2016
@danbev

Copy link
Copy Markdown
ContributorAuthor

danbev added a commit to danbev/node that referenced this pull request Nov 7, 2016
The doc target currently echos the complete shell command, which might
produces a lot of output. Using this change the actual commands run
are still shown.
Before:
[ -e tools/doc/node_modules/js-yaml/package.json ] || \
[ -e tools/eslint/node_modules/js-yaml/package.json ] || \
if [ -x ./node ]; then \
cd tools/doc && ../.././node ../.././deps/npm/bin/npm-cli.js
install; \
else \
cd tools/doc && node ../.././deps/npm/bin/npm-cli.js
install; \
fi
[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md
After:
[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md
To verify run:
$ make docclean
$ make doc
PR-URL: nodejs#9457
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James Snell <jasnell@gmail.com>
@danbev

Copy link
Copy Markdown
ContributorAuthor

Landed in: bc229d0

@danbevdanbev closed this Nov 7, 2016
evanlucas pushed a commit that referenced this pull request Nov 7, 2016
The doc target currently echos the complete shell command, which might
produces a lot of output. Using this change the actual commands run
are still shown.
Before:
[ -e tools/doc/node_modules/js-yaml/package.json ] || \
[ -e tools/eslint/node_modules/js-yaml/package.json ] || \
if [ -x ./node ]; then \
cd tools/doc && ../.././node ../.././deps/npm/bin/npm-cli.js
install; \
else \
cd tools/doc && node ../.././deps/npm/bin/npm-cli.js
install; \
fi
[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md
After:
[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md
To verify run:
$ make docclean
$ make doc
PR-URL: #9457
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James Snell <jasnell@gmail.com>
@evanlucasevanlucas mentioned this pull request Nov 7, 2016
MylesBorins pushed a commit that referenced this pull request Nov 22, 2016
The doc target currently echos the complete shell command, which might
produces a lot of output. Using this change the actual commands run
are still shown.
Before:
[ -e tools/doc/node_modules/js-yaml/package.json ] || \
[ -e tools/eslint/node_modules/js-yaml/package.json ] || \
if [ -x ./node ]; then \
cd tools/doc && ../.././node ../.././deps/npm/bin/npm-cli.js
install; \
else \
cd tools/doc && node ../.././deps/npm/bin/npm-cli.js
install; \
fi
[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md
After:
[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md
To verify run:
$ make docclean
$ make doc
PR-URL: #9457
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Nov 22, 2016
The doc target currently echos the complete shell command, which might
produces a lot of output. Using this change the actual commands run
are still shown.
Before:
[ -e tools/doc/node_modules/js-yaml/package.json ] || \
[ -e tools/eslint/node_modules/js-yaml/package.json ] || \
if [ -x ./node ]; then \
cd tools/doc && ../.././node ../.././deps/npm/bin/npm-cli.js
install; \
else \
cd tools/doc && node ../.././deps/npm/bin/npm-cli.js
install; \
fi
[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md
After:
[ -x ./node ] && ./node tools/doc/generate.js --node-version=v8.0.0
--format=html --template=doc/template.html doc/api/assert.md >
out/doc/api/assert.html || node tools/doc/generate.js
--node-version=v8.0.0 --format=html --template=doc/template.html
doc/api/assert.md > out/doc/api/assert.html
Input file = doc/api/assert.md
To verify run:
$ make docclean
$ make doc
PR-URL: #9457
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James Snell <jasnell@gmail.com>
This was referenced Nov 22, 2016
@danbev
danbev deleted the reduce-noice-of-doc-target branch January 17, 2017 07:21
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

buildIssues and PRs related to build files or the CI.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@danbev@jasnell@Fishrock123@cjihrig@MylesBorins@nodejs-github-bot