doc: better document `--shared` build #14158

refack · 2017-07-10T19:11:09Z

Version: *
Platform: *
Subsystem: build,doc

./configure --shared / vcbuild shared should be better documented.

How to build
How to use
Support level

The text was updated successfully, but these errors were encountered:

addaleax · 2017-07-10T19:13:55Z

If I may make the suggestion, we should also test it in some way if possible.

refack · 2017-07-10T19:14:39Z

If I may make the suggestion, we should also test it in some way if possible.

If we decide to support, maybe it should be deprecated?

[edit]
I'm just playing devil's advocate, it think it's an important meta-feature. But without CI testing it has rotted...
@electron @nwjs @nodejs/electron-installer @nodejs/build

gibfahn · 2017-07-11T23:35:00Z

cc/ @mhdawson, @a-roberts (and maybe @sam-github) who were looking at this.

mhdawson · 2017-07-13T16:13:53Z

I've had it on our internal backlog to push this forward, we've just not gotten started on it yet. My starting goals are:

define set of tests to validate shared library works
add tests to ci, ideally in the regression runs
look at how we can better package/delivery, ideally as part of the binaries we already ship. Challenge on this front is not increasing the package size so we may need to look at moving to the node binary being a launcher that uses the shared library, this is what Java does.

mhdawson · 2017-07-13T16:14:36Z

And I'm firmly on the side that we need to improve not remove. It is used by electron and we also have internal products that need it.

mhdawson · 2017-07-13T16:16:06Z

The person(s) on our team who worked on this in the past have moved on to a different project. My next step is to schedule some handover with them but then it will still be a matter on finding time to move it forward.

refack · 2017-07-13T16:18:24Z

add tests to ci, ideally in the regression runs

#13078 tried to get cctest to link against the shared lib. Could ideally become said launcher so we can run the JS suite against it.

refack · 2017-07-13T16:19:55Z

#13078 tried to get cctest to link against the shared lib. Could ideally become said launcher so we can run the JS suite against it.

Alternatively create something like d8 that will both serve as a test harness and an embedding example.

mhdawson · 2017-09-06T19:33:33Z

@gibfahn can you post the launcher code that we already have for testing the shared library ? I've not had time to get back to this and it would at least be something we can discuss here in terms of moving forward on the testing.

mhdawson · 2017-09-06T22:20:11Z

Seein #15195 maybe we should add a job that simply compiles the shared library as a first step towards fully testing it.

refack · 2017-09-12T18:05:34Z

IMHO a job that just compiles for linux+Windows+macOS would be a great start

mhdawson · 2017-09-13T15:22:02Z

It should compile and build across all platforms so I don't think there is any reason to limit the target platforms.

yhwang · 2017-09-19T22:26:47Z

start to trace the current --shared and --enable-static options in configure and agreed with @refack about this:

IMHO a job that just compiles for linux+Windows+macOS would be a great start

and maybe both --shared and --enable-static need to be verified

yhwang · 2017-09-27T20:52:00Z

after studying the static/shared lib build process, my thinking is maybe we should build the static lib and use it to build the node executable. reason being are:

directly integrate the static lib build with node executable
node executable also use static lib and run test against node executable is also some sort of verification of static lib
no performance impact of the node executable when using static lib. because there is still some performance impact when using shared lib

any thoughts?

Refine the static and shared lib build process in order to integrate static and shared lib verfication into CI. When building both static and shared lib, we still build node executable now and it uses the shared and static lib. Signed-off-by: Yihong Wang <yh.wang@ibm.com> Refs: nodejs#14158 PR-URL: nodejs#17604 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>

Refine the static and shared lib build process in order to integrate static and shared lib verfication into CI. When building both static and shared lib, we still build node executable now and it uses the shared and static lib. Signed-off-by: Yihong Wang <yh.wang@ibm.com> Refs: #14158 PR-URL: #17604 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>

Refine the static and shared lib build process in order to integrate static and shared lib verfication into CI. When building both static and shared lib, we still build node executable now and it uses the shared and static lib. Signed-off-by: Yihong Wang <yh.wang@ibm.com> Refs: #14158 Backport-PR-URL: #19050 PR-URL: #17604 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>

Refine the static and shared lib build process in order to integrate static and shared lib verfication into CI. When building both static and shared lib, we still build node executable now and it uses the shared and static lib. Signed-off-by: Yihong Wang <yh.wang@ibm.com> Refs: #14158 PR-URL: #17604 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>

Refine the static and shared lib build process in order to integrate static and shared lib verfication into CI. When building both static and shared lib, we still build node executable now and it uses the shared and static lib. Signed-off-by: Yihong Wang <yh.wang@ibm.com> Refs: #14158 Backport-PR-URL: #19050 PR-URL: #17604 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>

Refine the static and shared lib build process in order to integrate static and shared lib verfication into CI. When building both static and shared lib, we still build node executable now and it uses the shared and static lib. Signed-off-by: Yihong Wang <yh.wang@ibm.com> Refs: #14158 PR-URL: #17604 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>

Trott · 2019-02-17T05:05:41Z

What remains to be done here?

jasnell · 2020-06-26T00:10:16Z

This has not been updated in over a year and it's not clear what remaining actions there are. Closing but it can be reopened and I'm putting it on the Futures project board so it does not get lost.

mhdawson · 2020-07-02T19:32:56Z

@jasnell I think you failed to close so I'll do that. I still think we need a better defined API/documentation but I've not been able to line up people to work on it so I'll close for now.

refack added build Issues and PRs related to build files or the CI. help wanted Issues that need assistance from volunteers or PRs that need help to proceed. labels Jul 10, 2017

refack mentioned this issue Jul 10, 2017

Is there a place to download node.js shared library(libnode.so.{version}) for each platform? #8118

Closed

refack added the doc Issues and PRs related to the documentations. label Jul 10, 2017

addaleax added the test Issues and PRs related to the tests. label Jul 10, 2017

refack mentioned this issue Jul 11, 2017

Embeded nodejs in Win32 application nodejs/help#585

Closed

refack mentioned this issue Jul 15, 2017

Silent Mode execution #556

Closed

This was referenced Jul 20, 2017

how to embed nodejs in win32 non-console application nodejs/help#697

Closed

Does NodeJS have any plans for shared memory? nodejs/help#560

Closed

dominictarr mentioned this issue Jul 30, 2017

libnode.so for 32 bit is missing node-on-mobile/node-on-android#4

Open

refack mentioned this issue Aug 16, 2017

build: don't add libraries when --enable-static #14837

Closed

2 tasks

This was referenced Aug 23, 2017

test: --enable-static linked executable #14986

Closed

build: for --enable-static, run only cctest #14892

Closed

refack mentioned this issue Sep 6, 2017

Linker error, while compiling node js from source (as a shared library) - v 6.11.2 #15195

Closed

gibfahn self-assigned this Sep 6, 2017

refack mentioned this issue Sep 12, 2017

assert node can be compiled as static / dynamic libraries nodejs/build#879

Closed

yhwang mentioned this issue Feb 27, 2018

[v8.x backport] build: refine static and shared lib build #19047

Closed

2 tasks

yhwang mentioned this issue Feb 28, 2018

[v6.x backport] build: refine static and shared lib build #19050

Closed

2 tasks

mhdawson mentioned this issue Apr 12, 2018

Form team/group to define "embedding requirements" nodejs/user-feedback#51

Open

refack mentioned this issue Nov 4, 2018

Discussion: How should the Node executable + Node shared library be distributed? #24028

Closed

trivikr added the Hacktoberfest label Oct 1, 2019

aschaeffer mentioned this issue Oct 6, 2019

Evaluate if embedding Node.js as a static library is easier than embedding V8 inexorgame-obsolete/entity-system-inactive#129

Open

Trott removed the Hacktoberfest label Nov 3, 2019

mhdawson closed this as completed Jul 2, 2020

Mudr0x mentioned this issue Jul 17, 2021

Solutions to use NodeJS with multiple cores with a shared memory Karsens/pluribus-poker-bot-js#2

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: better document `--shared` build #14158

doc: better document `--shared` build #14158

refack commented Jul 10, 2017

addaleax commented Jul 10, 2017

refack commented Jul 10, 2017 •

edited

Loading

gibfahn commented Jul 11, 2017

mhdawson commented Jul 13, 2017

mhdawson commented Jul 13, 2017

mhdawson commented Jul 13, 2017

refack commented Jul 13, 2017

refack commented Jul 13, 2017

mhdawson commented Sep 6, 2017

mhdawson commented Sep 6, 2017

refack commented Sep 12, 2017

mhdawson commented Sep 13, 2017

yhwang commented Sep 19, 2017 •

edited

Loading

yhwang commented Sep 27, 2017

Trott commented Feb 17, 2019

jasnell commented Jun 26, 2020

mhdawson commented Jul 2, 2020

doc: better document --shared build #14158

doc: better document --shared build #14158

Comments

refack commented Jul 10, 2017

addaleax commented Jul 10, 2017

refack commented Jul 10, 2017 • edited Loading

gibfahn commented Jul 11, 2017

mhdawson commented Jul 13, 2017

mhdawson commented Jul 13, 2017

mhdawson commented Jul 13, 2017

refack commented Jul 13, 2017

refack commented Jul 13, 2017

mhdawson commented Sep 6, 2017

mhdawson commented Sep 6, 2017

refack commented Sep 12, 2017

mhdawson commented Sep 13, 2017

yhwang commented Sep 19, 2017 • edited Loading

yhwang commented Sep 27, 2017

Trott commented Feb 17, 2019

jasnell commented Jun 26, 2020

mhdawson commented Jul 2, 2020

doc: better document `--shared` build #14158

doc: better document `--shared` build #14158

refack commented Jul 10, 2017 •

edited

Loading

yhwang commented Sep 19, 2017 •

edited

Loading