-
-
Notifications
You must be signed in to change notification settings - Fork 33.7k
doc: add guides to (navigational) _toc.md #6522
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
eljefedelrodeodeljefe
wants to merge
1
commit into
nodejs:master
from
eljefedelrodeodeljefe:doc/link-to-guides-toc
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| * [About the Guides](guides/about.html) | ||
|
|
||
| <div class="line"></div> | ||
|
|
||
| * [Compilation](guides/compilation.md) | ||
| * [Compile Node with Ninja](guides/compilation/building-node-with-ninja.html) | ||
|
|
||
| <div class="line"></div> | ||
|
|
||
| * [GitHub Repo & Issue Tracker](https://github.com/nodejs/node) | ||
| * [Mailing List](http://groups.google.com/group/nodejs) |
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Building Node with Ninja | ||
|
|
||
| The purpose of this guide is to show how to build Node.js using [Ninja][], as doing so can be significantly quicker than using `make`. Please see [Ninja's site][Ninja] for installation instructions (unix only). | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. long line |
||
|
|
||
| To build Node with ninja, there are 4 steps that must be taken: | ||
|
|
||
| 1. Configure the project's OS-based build rules via `./configure` as usual. | ||
| 2. Use `tools/gyp_node.py -f ninja` to produce Ninja-buildable `gyp` output. | ||
| 3. Run `ninja -C out/Release` to produce a compiled release binary. | ||
| 4. Lastly, make symlink to `./node` using `ln -fs out/Release/node node`. | ||
|
|
||
| When running `ninja -C out/Release` you will see output similar to the following if the build has succeeded: | ||
| ``` | ||
| ninja: Entering directory `out/Release` | ||
| [4/4] LINK node, POSTBUILDS | ||
| ``` | ||
|
|
||
| The bottom line will change while building, showing the progress as `[finished/total]` build steps. | ||
| This is useful output that `make` does not produce and is one of the benefits of using Ninja. | ||
| Also, Ninja will likely compile much faster than even `make -j8` (or `-j<number of processor threads on your machine>`). | ||
|
|
||
| ## Considerations | ||
|
|
||
| Ninja builds vary slightly from `make` builds. If you wish to run `make test` after, `make` will likely still need to rebuild some amount of Node. | ||
|
|
||
| As such, if you wish to run the tests, it can be helpful to invoke the test runner directly, like so: | ||
| `tools/test.py --mode=release message parallel sequential -J` | ||
|
|
||
| ## Alias | ||
|
|
||
| `alias nnode='./configure && tools/gyp_node.py -f ninja && ninja -C out/Release && ln -fs out/Release/node node'` | ||
|
|
||
| ## Producing a debug build | ||
|
|
||
| The above alias can be modified slightly to produce a debug build, rather than a release build as shown below: | ||
| `alias nnodedebug='./configure && tools/gyp_node.py -f ninja && ninja -C out/Debug && ln -fs out/Debug/node node_g'` | ||
|
|
||
|
|
||
| [Ninja]: https://martine.github.io/ninja/ | ||
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Guides | ||
|
|
||
| Welcome to the Node guides. The guides discuss high-level and more advanced | ||
| topics and is hence an extension to the API documentation. Also the format of | ||
| the guides allows for more opinionated discussion about topics of the Node and | ||
| JavaScript community, while being strictly educative. | ||
|
|
||
| @include _toc.md |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this part of this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
git mv the one file that was already there into some sort of file structure