summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEvan Martin <martine@danga.com>2012-05-04 23:04:59 (GMT)
committerEvan Martin <martine@danga.com>2012-05-04 23:04:59 (GMT)
commitc95042dd0acaa45b3db379a2cdd377d607f91385 (patch)
treec0609d8f298f83683cc35a5e98af0fb07ce8b886
parentc5c535e80801879e7dc23bea5ac9f54c99797174 (diff)
downloadNinja-c95042dd0acaa45b3db379a2cdd377d607f91385.zip
Ninja-c95042dd0acaa45b3db379a2cdd377d607f91385.tar.gz
Ninja-c95042dd0acaa45b3db379a2cdd377d607f91385.tar.bz2
mention platform support
-rw-r--r--doc/manual.asciidoc14
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/manual.asciidoc b/doc/manual.asciidoc
index f6c1dda..71225f0 100644
--- a/doc/manual.asciidoc
+++ b/doc/manual.asciidoc
@@ -130,6 +130,13 @@ but they are not part of make itself.)
Using Ninja for your project
----------------------------
+Ninja currently works on Unix-like systems. It's seen the most testing
+on Linux (and has the best performance there) but it runs fine on Mac
+OS X and FreeBSD. Ninja has some preliminary Windows support but the
+full details of the implementation -- like how to get C header
+interdependencies correct and fast when using MSVC's compiler -- is
+not yet complete.
+
If your project is small, Ninja's speed impact is likely unnoticable.
Some build timing numbers are included below. (However, even for
small projects it sometimes turns out that Ninja's limited syntax
@@ -148,7 +155,8 @@ meta-build system.
http://code.google.com/p/gyp/[gyp]:: The meta-build system used to
generate build files for Google Chrome. gyp can generate Ninja files
-for Linux and Mac and is used by many Chrome developers. See the
+for Linux and Mac and is used by many Chrome developers; support for
+Windows is in progress. See the
http://code.google.com/p/chromium/wiki/NinjaBuild[Chromium Ninja
documentation for more details]. gyp is relatively unpopular outside
of the Chrome and v8 world.
@@ -163,7 +171,9 @@ of the Chrome and v8 world.
almost all of them will be over a minute."
http://www.cmake.org/[CMake]:: A widely used meta-build system that
-can generate Ninja files as of version 2.8.8.
+can generate Ninja files on Linux as of CMake version 2.8.8. (There
+is some Mac and Windows support, but those platforms are not yet
+officially supported by CMake as the full test suite doesn't pass.)
* For building Blender, one user reported "Single file rebuild is 0.97
sec, same on makefiles was 3.7sec."