summaryrefslogtreecommitdiff
path: root/BUILDING.md
diff options
context:
space:
mode:
authorJesse McCarthy <git_commits@jessemccarthy.net>2015-11-18 17:40:03 -0500
committerMyles Borins <mborins@us.ibm.com>2016-05-10 10:38:28 -0700
commit101dd1ed789175311ab22f9a32dfc480f127bc68 (patch)
tree499c48c33a7f22934e656eef6ad6aa3ea209546b /BUILDING.md
parent4f925dd1844f104e5a4e94ffc86783afcabeed82 (diff)
downloadandroid-node-v8-101dd1ed789175311ab22f9a32dfc480f127bc68.tar.gz
android-node-v8-101dd1ed789175311ab22f9a32dfc480f127bc68.tar.bz2
android-node-v8-101dd1ed789175311ab22f9a32dfc480f127bc68.zip
build: add Make `doc-only` target
Allows building just docs using existing Node instead of building Node first. PR-URL: https://github.com/nodejs/node/pull/3888 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
Diffstat (limited to 'BUILDING.md')
-rw-r--r--BUILDING.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/BUILDING.md b/BUILDING.md
index 7e52658eec..e9bf0bc013 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -67,10 +67,20 @@ $ make test-npm
To build the documentation:
+This will build Node.js first (if necessary) and then use it to build the docs:
+
```text
$ make doc
```
+If you have an existing Node.js you can build just the docs with:
+
+```text
+$ NODE=node make doc-only
+```
+
+(Where `node` is the path to your executable.)
+
To read the documentation:
```text