Skip to content

doc: improve addons.markdown copy - #4320

Closed
jasnell wants to merge 2 commits into
nodejs:masterfrom
jasnell:doc-addon-improvements
Closed

doc: improve addons.markdown copy#4320
jasnell wants to merge 2 commits into
nodejs:masterfrom
jasnell:doc-addon-improvements

Conversation

@jasnell

Copy link
Copy Markdown
Member

General improvements to the documentation in addons.markdown.

/cc @nodejs/documentation

@jasnelljasnell added doc Issues and PRs related to the documentations. lts-watch-v4.x labels Dec 17, 2015
@jasnell

Copy link
Copy Markdown
MemberAuthor

ping ... @nodejs/collaborators @rvagg

@jasnell
jasnellforce-pushed the doc-addon-improvements branch from bb9b8a9 to 7dfd86fCompareDecember 18, 2015 01:28
Comment threaddoc/api/addons.markdown Outdated

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.

s/The/the

@jasnell

Copy link
Copy Markdown
MemberAuthor

@rvagg ... thank you for the review! Pushed an update with fixes... still need to figure out #4320 (comment) tho... will look at that next

@jasnell

Copy link
Copy Markdown
MemberAuthor

@rvagg ... ok, added some language on the deps headers. PTAL

Comment threaddoc/api/addons.markdown Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The filenames should have use lowercase v8.

@jasnell

Copy link
Copy Markdown
MemberAuthor

@ofrobots ... fixed!

Comment threaddoc/api/addons.markdown Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

require is not a statement

General improvements to the documentation in addons.markdown.
@jasnell
jasnellforce-pushed the doc-addon-improvements branch from 66f9dbe to ed570d5CompareDecember 21, 2015 19:04
Comment threaddoc/api/addons.markdown Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In few other places it is referred as V8.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

sigh lol... I keep missing these. Hopefully this is the last one

@jasnell

Copy link
Copy Markdown
MemberAuthor

@thefourtheye ... fixed!

@thefourtheye

Copy link
Copy Markdown
Contributor

@jasnell I didn't try all the code examples. But except the comment about dynamically linked thingy, everything else LGTM.

@jasnell

Copy link
Copy Markdown
MemberAuthor

+1 ... I dropped the "statically" in that one paragraph.

@thefourtheye

Copy link
Copy Markdown
Contributor

Actually I would like to understand that paragraph better. So, if you don't mind, let's wait for one more LGTM.

If the Addons were to dynamically link to V8, then the V8 has to be compiled and installed as a separate library in the target machine, right? Only then the Addons can load them at runtime. Is that the case here?

@bnoordhuis

Copy link
Copy Markdown
Member

The node binary exports the public symbols from libv8.a. Add-ons themselves don't load libv8, their references to V8 API functions are resolved by the dynamic linker at run-time to the ones from the node binary.

@jasnell

Copy link
Copy Markdown
MemberAuthor

Given the couple of days that have passed and no further comments, I'm going to go ahead and land this.

jasnell added a commit that referenced this pull request Dec 23, 2015
General improvements to the documentation in addons.markdown.
PR-URL: #4320
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@jasnell

Copy link
Copy Markdown
MemberAuthor

Landed in d5863bc

@jasnelljasnell closed this Dec 23, 2015
@MylesBorins

Copy link
Copy Markdown
Contributor

this one is merging with conflicts, and I believe there is a second commit @rvagg to fix some regressions this created. @jasnell can you take the lead on this one?

@jasnell

Copy link
Copy Markdown
MemberAuthor

I'll handle porting these.

Fishrock123 pushed a commit to Fishrock123/node that referenced this pull request Jan 6, 2016
General improvements to the documentation in addons.markdown.
PR-URL: nodejs#4320
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@MylesBorinsMylesBorins mentioned this pull request Jan 28, 2016
@jasnell

Copy link
Copy Markdown
MemberAuthor

@thealphanerd ... will be porting this to LTS early next week

jasnell added a commit to jasnell/node that referenced this pull request Feb 19, 2016
General improvements to the documentation in addons.markdown.
PR-URL: nodejs#4320
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
General improvements to the documentation in addons.markdown.
PR-URL: #4320
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
General improvements to the documentation in addons.markdown.
PR-URL: #4320
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 2, 2016
General improvements to the documentation in addons.markdown.
PR-URL: #4320
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
General improvements to the documentation in addons.markdown.
PR-URL: nodejs#4320
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@jasnell@mcollina@bnoordhuis@thefourtheye@MylesBorins@ofrobots@rvagg@r-52