1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
5 | %general-entities;
|
---|
6 | ]>
|
---|
7 |
|
---|
8 | <sect1 id="ch-system-ninja" role="wrap">
|
---|
9 | <?dbhtml filename="ninja.html"?>
|
---|
10 |
|
---|
11 | <sect1info condition="script">
|
---|
12 | <productname>ninja</productname>
|
---|
13 | <productnumber>&ninja-version;</productnumber>
|
---|
14 | <address>&ninja-url;</address>
|
---|
15 | </sect1info>
|
---|
16 |
|
---|
17 | <title>Ninja-&ninja-version;</title>
|
---|
18 |
|
---|
19 | <indexterm zone="ch-system-ninja">
|
---|
20 | <primary sortas="a-Ninja">Ninja</primary>
|
---|
21 | </indexterm>
|
---|
22 |
|
---|
23 | <sect2 role="package">
|
---|
24 | <title/>
|
---|
25 |
|
---|
26 | <para>Ninja is a small build system with a focus on speed.</para>
|
---|
27 |
|
---|
28 | <segmentedlist>
|
---|
29 | <segtitle>&buildtime;</segtitle>
|
---|
30 | <segtitle>&diskspace;</segtitle>
|
---|
31 |
|
---|
32 | <seglistitem>
|
---|
33 | <seg>&ninja-ch6-sbu;</seg>
|
---|
34 | <seg>&ninja-ch6-du;</seg>
|
---|
35 | </seglistitem>
|
---|
36 | </segmentedlist>
|
---|
37 |
|
---|
38 | </sect2>
|
---|
39 |
|
---|
40 | <sect2 role="installation">
|
---|
41 | <title>Installation of Ninja</title>
|
---|
42 |
|
---|
43 | <para>When run, ninja normally runs a maximum number of processes
|
---|
44 | in parallel. By default this is the number of cores on the system
|
---|
45 | plus two. In some cases this can overheat a CPU or run a system out
|
---|
46 | of memory. If run from the command line, passing a -jN parameter
|
---|
47 | will limit the number of parallel processes, but some packages
|
---|
48 | embed the execution of ninja and do not pass a -j parameter.</para>
|
---|
49 |
|
---|
50 | <para>Using the <emphasis>optional</emphasis> patch below allows a user to
|
---|
51 | limit the number of parallel processes via an environment variable,
|
---|
52 | NINJAJOBS. <command>For example</command> setting:
|
---|
53 |
|
---|
54 | <!-- Using <command> here to make the output bold. We really don't want
|
---|
55 | users setting this now and experience shows that many users blindly
|
---|
56 | copy/paste anything in a box. -->
|
---|
57 |
|
---|
58 | <screen>export NINJAJOBS=4</screen>
|
---|
59 |
|
---|
60 | will limit ninja to four parallel processes.</para>
|
---|
61 |
|
---|
62 | <para>If desired, install the patch by running:</para>
|
---|
63 |
|
---|
64 | <screen><userinput remap="pre">patch -Np1 -i ../ninja-1.8.2-add_NINJAJOBS_var-1.patch</userinput></screen>
|
---|
65 |
|
---|
66 | <para>Build Ninja with:</para>
|
---|
67 |
|
---|
68 | <screen><userinput remap="configure">python3 configure.py --bootstrap</userinput></screen>
|
---|
69 |
|
---|
70 | <variablelist>
|
---|
71 | <title>The meaning of the build option:</title>
|
---|
72 |
|
---|
73 | <varlistentry>
|
---|
74 | <term><parameter>--bootstrap</parameter></term>
|
---|
75 | <listitem>
|
---|
76 | <para>This parameter forces ninja to rebuild itself for the current
|
---|
77 | system.</para>
|
---|
78 | </listitem>
|
---|
79 | </varlistentry>
|
---|
80 |
|
---|
81 | </variablelist>
|
---|
82 |
|
---|
83 | <para>To test the results, issue:</para>
|
---|
84 |
|
---|
85 | <screen><userinput remap="test">python3 configure.py
|
---|
86 | ./ninja ninja_test
|
---|
87 | ./ninja_test --gtest_filter=-SubprocessTest.SetWithLots</userinput></screen>
|
---|
88 |
|
---|
89 | <para>Install the package:</para>
|
---|
90 |
|
---|
91 | <screen><userinput remap="install">install -vm755 ninja /usr/bin/
|
---|
92 | install -vDm644 misc/bash-completion /usr/share/bash-completion/completions/ninja
|
---|
93 | install -vDm644 misc/zsh-completion /usr/share/zsh/site-functions/_ninja</userinput></screen>
|
---|
94 |
|
---|
95 | </sect2>
|
---|
96 |
|
---|
97 | <sect2 id="contents-ninja" role="content">
|
---|
98 | <title>Contents of Ninja</title>
|
---|
99 |
|
---|
100 | <segmentedlist>
|
---|
101 | <segtitle>Installed programs</segtitle>
|
---|
102 |
|
---|
103 | <seglistitem>
|
---|
104 | <seg>ninja</seg>
|
---|
105 | </seglistitem>
|
---|
106 | </segmentedlist>
|
---|
107 | <variablelist>
|
---|
108 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
109 | <?dbfo list-presentation="list"?>
|
---|
110 | <?dbhtml list-presentation="table"?>
|
---|
111 |
|
---|
112 | <varlistentry id="ninja">
|
---|
113 | <term><command>ninja</command></term>
|
---|
114 | <listitem>
|
---|
115 | <para>is the Ninja build system.</para>
|
---|
116 | <indexterm zone="ch-system-ninja ninja">
|
---|
117 | <primary sortas="b-ninja">ninja</primary>
|
---|
118 | </indexterm>
|
---|
119 | </listitem>
|
---|
120 | </varlistentry>
|
---|
121 |
|
---|
122 | </variablelist>
|
---|
123 |
|
---|
124 | </sect2>
|
---|
125 |
|
---|
126 | </sect1>
|
---|
127 |
|
---|