Skip to content

doc: add unrepresented flags docs for configure - #28069

Closed
rexagod wants to merge 3 commits into
nodejs:masterfrom
rexagod:doc-17331
Closed

doc: add unrepresented flags docs for configure#28069
rexagod wants to merge 3 commits into
nodejs:masterfrom
rexagod:doc-17331

Conversation

@rexagod

Copy link
Copy Markdown
Member
  • added documentation to support usage of advanced features of configure on Windows

Fixes: #17331

Checklist

/cc @refack

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Jun 5, 2019
@rexagodrexagod changed the title doc: add unrepresented flags docs for configuredoc: add unrepresented flags docs for configureJun 5, 2019
Comment threaddoc/guides/maintaining-the-build-files.md Outdated
@refackrefack added build Issues and PRs related to build files or the CI. windows Issues and PRs related to the Windows platform. labels Jun 5, 2019
@refack

refack commented Jun 5, 2019

Copy link
Copy Markdown
Contributor

@rexagod this looks good to me (modulo lint).

Would we be willing to add some similar words to the runtime help? Somewhere near:

node/vcbuild.bat

Lines 684 to 696 in 2c76874

:help
echo vcbuild.bat [debug/release] [msi] [doc] [test/test-all/test-addons/test-js-native-api/test-node-api/test-benchmark/test-internet/test-pummel/test-simple/test-message/test-tick-processor/test-known-issues/test-node-inspect/test-check-deopts/test-npm/test-async-hooks/test-v8/test-v8-intl/test-v8-benchmarks/test-v8-all] [ignore-flaky] [static/dll] [noprojgen] [projgen] [small-icu/full-icu/without-intl] [nobuild] [nosnapshot] [noetw] [ltcg] [licensetf] [sign] [ia32/x86/x64/arm64] [vs2017] [download-all] [enable-vtune] [lint/lint-ci/lint-js/lint-js-ci/lint-md] [lint-md-build] [package] [build-release] [upload] [no-NODE-OPTIONS] [link-module path-to-module] [debug-http2] [debug-nghttp2] [clean] [cctest] [no-cctest] [openssl-no-asm]
echo Examples:
echo vcbuild.bat : builds release build
echo vcbuild.bat debug : builds debug build
echo vcbuild.bat release msi : builds release build and MSI installer package
echo vcbuild.bat test : builds debug build and runs tests
echo vcbuild.bat build-release : builds the release distribution as used by nodejs.org
echo vcbuild.bat enable-vtune : builds nodejs with Intel VTune profiling support to profile JavaScript
echo vcbuild.bat link-module my_module.js : bundles my_module as built-in module
echo vcbuild.bat lint : runs the C++, documentation and JavaScript linter
echo vcbuild.bat no-cctest : skip building cctest.exe
gotoexit

@rexagod

Copy link
Copy Markdown
MemberAuthor

@refack Hey! Apologies for the delay, also, I was having a bit of trouble understanding what exactly to add in the vcbuild.bat file as per your suggestion above. Did you mean appending something like, echo vcbuild.bat noprojgen : builds release build after calling unrepresented flags on configure script into the examples above? Let me know either way and I'll fix this.

Thank you!

@rexagod

Copy link
Copy Markdown
MemberAuthor

Changing the first commit body!

rexagod added 3 commits June 8, 2019 03:38
developed on ffb1819 by wrapping content for lint tests to pass
Refs: nodejs#28069
added documentation to support usage of
advanced features of `configure` on Windows
Fixes: nodejs#17331
developed on fcc6b1 by wrapping content for lint tests to pass
Refs: nodejs#28069
@rexagod

Copy link
Copy Markdown
MemberAuthor

Pinging @refack for a look here. Thanks!

@bnoordhuisbnoordhuis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM although doc/guides/maintaining-the-build-files.md isn't perhaps the most visible place for it.

@gireeshpunathilgireeshpunathil added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 22, 2019
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

BridgeAR pushed a commit that referenced this pull request Dec 25, 2019
Added documentation to support usage of advanced features of
`configure` on Windows.
PR-URL: #28069Fixes: #17331
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@BridgeAR

Copy link
Copy Markdown
Member

Landed in 2c5d35e 🎉

The linter complaint due to recent changes. I fixed these issues while landing.

BridgeAR pushed a commit that referenced this pull request Jan 3, 2020
Added documentation to support usage of advanced features of
`configure` on Windows.
PR-URL: #28069Fixes: #17331
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@BridgeARBridgeAR mentioned this pull request Jan 7, 2020
targos pushed a commit that referenced this pull request Jan 14, 2020
Added documentation to support usage of advanced features of
`configure` on Windows.
PR-URL: #28069Fixes: #17331
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@targostargos mentioned this pull request Jan 15, 2020
BethGriggs pushed a commit that referenced this pull request Feb 6, 2020
Added documentation to support usage of advanced features of
`configure` on Windows.
PR-URL: #28069Fixes: #17331
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@MylesBorinsMylesBorins mentioned this pull request Feb 8, 2020
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.buildIssues and PRs related to build files or the CI.docIssues and PRs related to the documentations.windowsIssues and PRs related to the Windows platform.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: how to use advanced features of configure on Windows

7 participants

@rexagod@refack@nodejs-github-bot@BridgeAR@bnoordhuis@jasnell@gireeshpunathil