doc: add builtin module in building.md #17705

Suixinlei · 2017-12-16T05:21:36Z

Add builtin module doc in BUILDING.md and introduce --link-modules in doc.

Fixes: #12516
Refs: #2497

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

doc

Fishrock123 · 2017-12-16T05:55:55Z

I feel like this documentation belongs in the building docs and not in the API docs.

Suixinlei · 2017-12-16T06:42:27Z

Thank you for your advice.Should I close this pr and open the other one? @Fishrock123

joyeecheung · 2017-12-16T07:13:35Z

@Suixinlei You can just move the changes to BUILDING.md, amend the commit and force push to the PR branch, the PR description still applies if you move the changes there so I don't think it's necessary to close this one and open a new PR.

Suixinlei · 2017-12-16T08:05:29Z

@joyeecheung done. I've updated the pr and the commit.

vsemozhetbyt · 2017-12-16T11:05:44Z

BUILDING.md

+
+## Building Node.js with external core modules
+
+In general that core modules are only located in `lib/` folder.  Node can


Thank you!
Some tiny fixes:

that core modules -> those core modules.

Node -> Node.js.

@vsemozhetbyt Thanks a lot. I've already update my code.

vsemozhetbyt · 2017-12-16T14:11:56Z

CI lite: https://ci.nodejs.org/job/node-test-pull-request-lite/22/

XadillaX

I think the commit message shouldn't include Fixes since it's just a documentation changing. Maybe we can use Refs instead.

joyeecheung · 2017-12-18T10:15:06Z

BUILDING.md

+
+## Building Node.js with external core modules
+
+In general those core modules are only located in `lib/` folder.  Node.js can


The word "those" here looks a bit unnatural since the core modules are not mentioned before this section, and the fact that they are in the lib/ folder is not entirely relevant here since the internal modules are not exposed to users. I would suggest something simpler like:

It is possible to specify one or more JavaScript text files to be bundled in the binary as builtin modules when building Node.js.

joyeecheung · 2017-12-18T10:15:38Z

BUILDING.md

+specify one or more JavaScript text files to be bundled in the binary as
+builtin modules.
+
+##### Unix / macOS


We don't really need these many levels here, I think ### is enough.

joyeecheung · 2017-12-18T10:17:33Z

BUILDING.md

+##### Unix / macOS
+
+```console
+$ ./configure --link-module '/root/myModule.js'


Can you add an explanation for this command? Maybe something like To make `/root/myModule.js` available via `require('root/myModule')`:

joyeecheung · 2017-12-18T10:17:56Z

BUILDING.md

+##### Windows
+
+```console
+> .\vcbuild link-module './myModule.js'


Can you add an explanation for this command as well?

joyeecheung · 2017-12-18T10:21:23Z

BTW this does not fix #12516 which was asking about the bundled native modules (addons), not the JS modules.

BridgeAR · 2018-01-05T01:42:16Z

Ping @Suixinlei

Suixinlei · 2018-01-09T08:11:11Z

sorry, I wll fix this asap.

Fixes: nodejs#12516 Refs: nodejs#2497

Suixinlei · 2018-01-09T09:12:37Z

@joyeecheung thx for your advice, fix done.

joyeecheung · 2018-01-17T17:28:47Z

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/96/

joyeecheung · 2018-01-18T13:36:52Z

Landed in f2e62b5, thanks!

Fixes: #12516 Refs: #2497 PR-URL: #17705 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: James M Snell <[email protected]>

Fixes: nodejs#12516 Refs: nodejs#2497 PR-URL: nodejs#17705 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: James M Snell <[email protected]>

nodejs-github-bot added doc Issues and PRs related to the documentations. module Issues and PRs related to the module subsystem. labels Dec 16, 2017

Suixinlei force-pushed the doc-builtin-module branch 2 times, most recently from 2d48d8f to 478d696 Compare December 16, 2017 07:58

Suixinlei changed the title ~~doc: add builtin module in module.md~~ doc: add builtin module in building.md Dec 16, 2017

vsemozhetbyt reviewed Dec 16, 2017

View reviewed changes

Suixinlei force-pushed the doc-builtin-module branch 2 times, most recently from ad10522 to 615f11a Compare December 16, 2017 13:32

vsemozhetbyt approved these changes Dec 16, 2017

View reviewed changes

XadillaX reviewed Dec 18, 2017

View reviewed changes

joyeecheung reviewed Dec 18, 2017

View reviewed changes

Suixinlei force-pushed the doc-builtin-module branch from 615f11a to f34ce3b Compare January 9, 2018 08:54

doc: add builtin module in building.md

922c53e

Fixes: nodejs#12516 Refs: nodejs#2497

Suixinlei force-pushed the doc-builtin-module branch from f34ce3b to 922c53e Compare January 9, 2018 09:10

joyeecheung approved these changes Jan 9, 2018

View reviewed changes

joyeecheung added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 17, 2018

jasnell approved these changes Jan 17, 2018

View reviewed changes

joyeecheung closed this Jan 18, 2018

joyeecheung mentioned this pull request Jan 18, 2018

still does not detect some non-author committers nodejs/node-core-utils#150

Closed

addaleax removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 18, 2018

evanlucas mentioned this pull request Jan 30, 2018

v9.5.0 release proposal #18464

Merged

MylesBorins added dont-land-on-v6.x labels Feb 27, 2018

This was referenced Feb 27, 2018

v6.13.1 proposal #19025

Closed

v6.13.1 proposal #19027

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add builtin module in building.md #17705

doc: add builtin module in building.md #17705

Suixinlei commented Dec 16, 2017 •

edited

Loading

Fishrock123 commented Dec 16, 2017

Suixinlei commented Dec 16, 2017

joyeecheung commented Dec 16, 2017

Suixinlei commented Dec 16, 2017

vsemozhetbyt Dec 16, 2017

Suixinlei Dec 16, 2017

vsemozhetbyt commented Dec 16, 2017

XadillaX left a comment

joyeecheung Dec 18, 2017

joyeecheung Dec 18, 2017

joyeecheung Dec 18, 2017

joyeecheung Dec 18, 2017

joyeecheung commented Dec 18, 2017

BridgeAR commented Jan 5, 2018

Suixinlei commented Jan 9, 2018

Suixinlei commented Jan 9, 2018

joyeecheung commented Jan 17, 2018

joyeecheung commented Jan 18, 2018


		## Building Node.js with external core modules

		In general that core modules are only located in `lib/` folder. Node can


		## Building Node.js with external core modules

		In general those core modules are only located in `lib/` folder. Node.js can

doc: add builtin module in building.md #17705

doc: add builtin module in building.md #17705

Conversation

Suixinlei commented Dec 16, 2017 • edited Loading

Checklist

Affected core subsystem(s)

Fishrock123 commented Dec 16, 2017

Suixinlei commented Dec 16, 2017

joyeecheung commented Dec 16, 2017

Suixinlei commented Dec 16, 2017

vsemozhetbyt Dec 16, 2017

Choose a reason for hiding this comment

Suixinlei Dec 16, 2017

Choose a reason for hiding this comment

vsemozhetbyt commented Dec 16, 2017

XadillaX left a comment

Choose a reason for hiding this comment

joyeecheung Dec 18, 2017

Choose a reason for hiding this comment

joyeecheung Dec 18, 2017

Choose a reason for hiding this comment

joyeecheung Dec 18, 2017

Choose a reason for hiding this comment

joyeecheung Dec 18, 2017

Choose a reason for hiding this comment

joyeecheung commented Dec 18, 2017

BridgeAR commented Jan 5, 2018

Suixinlei commented Jan 9, 2018

Suixinlei commented Jan 9, 2018

joyeecheung commented Jan 17, 2018

joyeecheung commented Jan 18, 2018

Suixinlei commented Dec 16, 2017 •

edited

Loading