Ninja
doxygen_mainpage
Go to the documentation of this file.
00001 /**
00002  * \mainpage
00003  * \section README
00004  * \verbatim
00005 Ninja is a small build system with a focus on speed.
00006 http://martine.github.com/ninja/
00007 
00008 See the manual -- http://martine.github.com/ninja/manual.html or
00009 doc/manual.asciidoc included in the distribution -- for background
00010 and more details.
00011 
00012 To build, run ./bootstrap.py.  It first blindly compiles all non-test
00013 source files together, then re-builds Ninja using itself.  You should
00014 end up with a 'ninja' binary in the source root.  Run './ninja -h' for
00015 help.
00016 
00017 There is no installation step.  The only file of interest to a user
00018 is the resulting ninja binary.
00019 
00020 If you're interested in making changes to Ninja, read HACKING.md first.
00021  \endverbatim
00022  * \section COPYING
00023  * \verbatim
00024 
00025                                  Apache License
00026                            Version 2.0, January 2010
00027                         http://www.apache.org/licenses/
00028 
00029    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
00030 
00031    1. Definitions.
00032 
00033       "License" shall mean the terms and conditions for use, reproduction,
00034       and distribution as defined by Sections 1 through 9 of this document.
00035 
00036       "Licensor" shall mean the copyright owner or entity authorized by
00037       the copyright owner that is granting the License.
00038 
00039       "Legal Entity" shall mean the union of the acting entity and all
00040       other entities that control, are controlled by, or are under common
00041       control with that entity. For the purposes of this definition,
00042       "control" means (i) the power, direct or indirect, to cause the
00043       direction or management of such entity, whether by contract or
00044       otherwise, or (ii) ownership of fifty percent (50%) or more of the
00045       outstanding shares, or (iii) beneficial ownership of such entity.
00046 
00047       "You" (or "Your") shall mean an individual or Legal Entity
00048       exercising permissions granted by this License.
00049 
00050       "Source" form shall mean the preferred form for making modifications,
00051       including but not limited to software source code, documentation
00052       source, and configuration files.
00053 
00054       "Object" form shall mean any form resulting from mechanical
00055       transformation or translation of a Source form, including but
00056       not limited to compiled object code, generated documentation,
00057       and conversions to other media types.
00058 
00059       "Work" shall mean the work of authorship, whether in Source or
00060       Object form, made available under the License, as indicated by a
00061       copyright notice that is included in or attached to the work
00062       (an example is provided in the Appendix below).
00063 
00064       "Derivative Works" shall mean any work, whether in Source or Object
00065       form, that is based on (or derived from) the Work and for which the
00066       editorial revisions, annotations, elaborations, or other modifications
00067       represent, as a whole, an original work of authorship. For the purposes
00068       of this License, Derivative Works shall not include works that remain
00069       separable from, or merely link (or bind by name) to the interfaces of,
00070       the Work and Derivative Works thereof.
00071 
00072       "Contribution" shall mean any work of authorship, including
00073       the original version of the Work and any modifications or additions
00074       to that Work or Derivative Works thereof, that is intentionally
00075       submitted to Licensor for inclusion in the Work by the copyright owner
00076       or by an individual or Legal Entity authorized to submit on behalf of
00077       the copyright owner. For the purposes of this definition, "submitted"
00078       means any form of electronic, verbal, or written communication sent
00079       to the Licensor or its representatives, including but not limited to
00080       communication on electronic mailing lists, source code control systems,
00081       and issue tracking systems that are managed by, or on behalf of, the
00082       Licensor for the purpose of discussing and improving the Work, but
00083       excluding communication that is conspicuously marked or otherwise
00084       designated in writing by the copyright owner as "Not a Contribution."
00085 
00086       "Contributor" shall mean Licensor and any individual or Legal Entity
00087       on behalf of whom a Contribution has been received by Licensor and
00088       subsequently incorporated within the Work.
00089 
00090    2. Grant of Copyright License. Subject to the terms and conditions of
00091       this License, each Contributor hereby grants to You a perpetual,
00092       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
00093       copyright license to reproduce, prepare Derivative Works of,
00094       publicly display, publicly perform, sublicense, and distribute the
00095       Work and such Derivative Works in Source or Object form.
00096 
00097    3. Grant of Patent License. Subject to the terms and conditions of
00098       this License, each Contributor hereby grants to You a perpetual,
00099       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
00100       (except as stated in this section) patent license to make, have made,
00101       use, offer to sell, sell, import, and otherwise transfer the Work,
00102       where such license applies only to those patent claims licensable
00103       by such Contributor that are necessarily infringed by their
00104       Contribution(s) alone or by combination of their Contribution(s)
00105       with the Work to which such Contribution(s) was submitted. If You
00106       institute patent litigation against any entity (including a
00107       cross-claim or counterclaim in a lawsuit) alleging that the Work
00108       or a Contribution incorporated within the Work constitutes direct
00109       or contributory patent infringement, then any patent licenses
00110       granted to You under this License for that Work shall terminate
00111       as of the date such litigation is filed.
00112 
00113    4. Redistribution. You may reproduce and distribute copies of the
00114       Work or Derivative Works thereof in any medium, with or without
00115       modifications, and in Source or Object form, provided that You
00116       meet the following conditions:
00117 
00118       (a) You must give any other recipients of the Work or
00119           Derivative Works a copy of this License; and
00120 
00121       (b) You must cause any modified files to carry prominent notices
00122           stating that You changed the files; and
00123 
00124       (c) You must retain, in the Source form of any Derivative Works
00125           that You distribute, all copyright, patent, trademark, and
00126           attribution notices from the Source form of the Work,
00127           excluding those notices that do not pertain to any part of
00128           the Derivative Works; and
00129 
00130       (d) If the Work includes a "NOTICE" text file as part of its
00131           distribution, then any Derivative Works that You distribute must
00132           include a readable copy of the attribution notices contained
00133           within such NOTICE file, excluding those notices that do not
00134           pertain to any part of the Derivative Works, in at least one
00135           of the following places: within a NOTICE text file distributed
00136           as part of the Derivative Works; within the Source form or
00137           documentation, if provided along with the Derivative Works; or,
00138           within a display generated by the Derivative Works, if and
00139           wherever such third-party notices normally appear. The contents
00140           of the NOTICE file are for informational purposes only and
00141           do not modify the License. You may add Your own attribution
00142           notices within Derivative Works that You distribute, alongside
00143           or as an addendum to the NOTICE text from the Work, provided
00144           that such additional attribution notices cannot be construed
00145           as modifying the License.
00146 
00147       You may add Your own copyright statement to Your modifications and
00148       may provide additional or different license terms and conditions
00149       for use, reproduction, or distribution of Your modifications, or
00150       for any such Derivative Works as a whole, provided Your use,
00151       reproduction, and distribution of the Work otherwise complies with
00152       the conditions stated in this License.
00153 
00154    5. Submission of Contributions. Unless You explicitly state otherwise,
00155       any Contribution intentionally submitted for inclusion in the Work
00156       by You to the Licensor shall be under the terms and conditions of
00157       this License, without any additional terms or conditions.
00158       Notwithstanding the above, nothing herein shall supersede or modify
00159       the terms of any separate license agreement you may have executed
00160       with Licensor regarding such Contributions.
00161 
00162    6. Trademarks. This License does not grant permission to use the trade
00163       names, trademarks, service marks, or product names of the Licensor,
00164       except as required for reasonable and customary use in describing the
00165       origin of the Work and reproducing the content of the NOTICE file.
00166 
00167    7. Disclaimer of Warranty. Unless required by applicable law or
00168       agreed to in writing, Licensor provides the Work (and each
00169       Contributor provides its Contributions) on an "AS IS" BASIS,
00170       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
00171       implied, including, without limitation, any warranties or conditions
00172       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
00173       PARTICULAR PURPOSE. You are solely responsible for determining the
00174       appropriateness of using or redistributing the Work and assume any
00175       risks associated with Your exercise of permissions under this License.
00176 
00177    8. Limitation of Liability. In no event and under no legal theory,
00178       whether in tort (including negligence), contract, or otherwise,
00179       unless required by applicable law (such as deliberate and grossly
00180       negligent acts) or agreed to in writing, shall any Contributor be
00181       liable to You for damages, including any direct, indirect, special,
00182       incidental, or consequential damages of any character arising as a
00183       result of this License or out of the use or inability to use the
00184       Work (including but not limited to damages for loss of goodwill,
00185       work stoppage, computer failure or malfunction, or any and all
00186       other commercial damages or losses), even if such Contributor
00187       has been advised of the possibility of such damages.
00188 
00189    9. Accepting Warranty or Additional Liability. While redistributing
00190       the Work or Derivative Works thereof, You may choose to offer,
00191       and charge a fee for, acceptance of support, warranty, indemnity,
00192       or other liability obligations and/or rights consistent with this
00193       License. However, in accepting such obligations, You may act only
00194       on Your own behalf and on Your sole responsibility, not on behalf
00195       of any other Contributor, and only if You agree to indemnify,
00196       defend, and hold each Contributor harmless for any liability
00197       incurred by, or claims asserted against, such Contributor by reason
00198       of your accepting any such warranty or additional liability.
00199 
00200    END OF TERMS AND CONDITIONS
00201 
00202    APPENDIX: How to apply the Apache License to your work.
00203 
00204       To apply the Apache License to your work, attach the following
00205       boilerplate notice, with the fields enclosed by brackets "[]"
00206       replaced with your own identifying information. (Don't include
00207       the brackets!)  The text should be enclosed in the appropriate
00208       comment syntax for the file format. We also recommend that a
00209       file or class name and description of purpose be included on the
00210       same "printed page" as the copyright notice for easier
00211       identification within third-party archives.
00212 
00213    Copyright [yyyy] [name of copyright owner]
00214 
00215    Licensed under the Apache License, Version 2.0 (the "License");
00216    you may not use this file except in compliance with the License.
00217    You may obtain a copy of the License at
00218 
00219        http://www.apache.org/licenses/LICENSE-2.0
00220 
00221    Unless required by applicable law or agreed to in writing, software
00222    distributed under the License is distributed on an "AS IS" BASIS,
00223    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00224    See the License for the specific language governing permissions and
00225    limitations under the License.
00226  \endverbatim
00227  */