Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/api/_toc.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
@// point at the new location.
* [About these Docs](documentation.html)
* [Usage & Example](synopsis.html)
* [Guides](guides/index.html)

<div class="line"></div>

Expand Down
11 changes: 11 additions & 0 deletions doc/guides/_toc.md
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 added doc/guides/about.md
Empty file.
39 changes: 39 additions & 0 deletions doc/guides/compilation/building-node-with-ninja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Building Node with Ninja
Copy link
Member

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?

Copy link
Contributor Author

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


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).
Copy link
Member

Choose a reason for hiding this comment

The 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.
8 changes: 8 additions & 0 deletions doc/guides/index.md
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