[114fd4e5] | 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 |
|
---|
[8dfc5c3] | 7 | <!ENTITY ninja-download-http "https://github.com/ninja-build/ninja/archive/v&ninja-version;/ninja-&ninja-version;.tar.gz">
|
---|
[114fd4e5] | 8 | <!ENTITY ninja-download-ftp " ">
|
---|
[bc02cdf] | 9 | <!ENTITY ninja-md5sum "f340be768a76724b83e6daab69009902">
|
---|
| 10 | <!ENTITY ninja-size "186 KB">
|
---|
| 11 | <!ENTITY ninja-buildsize "65 MB">
|
---|
[ff7511a] | 12 | <!ENTITY ninja-time "0.2 SBU">
|
---|
[114fd4e5] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="ninja" xreflabel="Ninja-&ninja-version;">
|
---|
| 16 | <?dbhtml filename="ninja.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>Ninja-&ninja-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="ninja">
|
---|
| 22 | <primary sortas="a-Ninja">Ninja</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to Ninja</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | <application>Ninja</application> is a small build system with a focus on
|
---|
| 30 | speed.
|
---|
| 31 | </para>
|
---|
| 32 |
|
---|
[caee7667] | 33 | <note>
|
---|
| 34 | <para>This package was installed as a part of the base LFS
|
---|
| 35 | system. The only reason to reinstall is to use the optional
|
---|
[dc69310d] | 36 | dependencies for additional support files or documentation.
|
---|
[caee7667] | 37 | </para>
|
---|
| 38 | </note>
|
---|
| 39 |
|
---|
[38489aa0] | 40 | &lfs84_checked;
|
---|
[114fd4e5] | 41 |
|
---|
| 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (HTTP): <ulink url="&ninja-download-http;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
[caee7667] | 49 | <listitem>
|
---|
[114fd4e5] | 50 | <para>
|
---|
| 51 | Download (FTP): <ulink url="&ninja-download-ftp;"/>
|
---|
| 52 | </para>
|
---|
[caee7667] | 53 | </listitem>
|
---|
[114fd4e5] | 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download MD5 sum: &ninja-md5sum;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Download size: &ninja-size;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated disk space required: &ninja-buildsize;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
| 70 | <para>
|
---|
| 71 | Estimated build time: &ninja-time;
|
---|
| 72 | </para>
|
---|
| 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
[ac9552f] | 76 | <bridgehead renderas="sect3">Ninja Dependencies</bridgehead>
|
---|
[114fd4e5] | 77 |
|
---|
| 78 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 79 | <para role="required">
|
---|
[caee7667] | 80 | <xref linkend="python3"/>
|
---|
[114fd4e5] | 81 | </para>
|
---|
| 82 |
|
---|
| 83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 84 | <para role="optional">
|
---|
[caee7667] | 85 | <xref linkend="asciidoc"/> (to build the manual),
|
---|
| 86 | <xref linkend="emacs"/> (to generate lisp files),
|
---|
| 87 | <xref linkend="doxygen"/> (to build API documentation), and
|
---|
[114fd4e5] | 88 | <ulink url="http://re2c.sourceforge.net/">re2c</ulink>
|
---|
[caee7667] | 89 | (only needed to modify the build)
|
---|
[114fd4e5] | 90 | </para>
|
---|
| 91 |
|
---|
| 92 | <para condition="html" role="usernotes">User Notes:
|
---|
| 93 | <ulink url="&blfs-wiki;/ninja"/>
|
---|
| 94 | </para>
|
---|
[ac9552f] | 95 |
|
---|
[114fd4e5] | 96 | </sect2>
|
---|
| 97 |
|
---|
| 98 | <sect2 role="installation">
|
---|
| 99 | <title>Installation of Ninja</title>
|
---|
| 100 |
|
---|
| 101 | <para>
|
---|
| 102 | Install <application>Ninja</application> by running the following
|
---|
| 103 | commands:
|
---|
| 104 | </para>
|
---|
| 105 |
|
---|
[caee7667] | 106 | <screen><userinput>python3 configure.py --bootstrap</userinput></screen>
|
---|
[114fd4e5] | 107 |
|
---|
| 108 | <para>If Emacs is installed and you wish to build lisp files:</para>
|
---|
| 109 |
|
---|
| 110 | <screen><userinput>emacs -Q --batch -f batch-byte-compile misc/ninja-mode.el</userinput></screen>
|
---|
| 111 |
|
---|
| 112 | <para>
|
---|
| 113 | To test the results, issue the following commands:
|
---|
| 114 | </para>
|
---|
| 115 |
|
---|
[caee7667] | 116 | <screen><userinput>python3 configure.py &&
|
---|
| 117 | ./ninja ninja_test &&
|
---|
[114fd4e5] | 118 | ./ninja_test --gtest_filter=-SubprocessTest.SetWithLots</userinput></screen>
|
---|
| 119 |
|
---|
| 120 | <para>
|
---|
| 121 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 122 | </para>
|
---|
| 123 |
|
---|
| 124 | <screen role="root"><userinput>install -vm755 ninja /usr/bin/ &&
|
---|
| 125 | install -vDm644 misc/ninja.vim \
|
---|
[e042e4ce] | 126 | /usr/share/vim/vim&vim-majmin;/syntax/ninja.vim &&
|
---|
[114fd4e5] | 127 | install -vDm644 misc/bash-completion \
|
---|
| 128 | /usr/share/bash-completion/completions/ninja &&
|
---|
| 129 | install -vDm644 misc/zsh-completion \
|
---|
[caee7667] | 130 | /usr/share/zsh/site-functions/_ninja</userinput></screen>
|
---|
[114fd4e5] | 131 |
|
---|
| 132 | <para>
|
---|
| 133 | If Emacs is installed, while still the
|
---|
| 134 | <systemitem class="username">root</systemitem> user:
|
---|
| 135 | </para>
|
---|
| 136 |
|
---|
| 137 | <screen role="root"><userinput>install -vDm644 misc/ninja-mode.el \
|
---|
| 138 | /usr/share/emacs/site-lisp/ninja-mode.el
|
---|
| 139 | install -vDm644 misc/ninja-mode.elc \
|
---|
| 140 | /usr/share/emacs/site-lisp/ninja-mode.elc</userinput></screen>
|
---|
[ac9552f] | 141 |
|
---|
| 142 | <para>
|
---|
| 143 | If you have <xref linkend="asciidoc"/> installed and wish to build the
|
---|
| 144 | HTML manual, execute the following commands (as the
|
---|
| 145 | <systemitem class="username">root</systemitem> user):
|
---|
| 146 | </para>
|
---|
| 147 |
|
---|
| 148 | <screen role="root"><userinput>ninja manual &&
|
---|
[ff7511a] | 149 | install -vDm644 doc/manual.html /usr/share/doc/ninja-&ninja-version;/manual.html</userinput></screen>
|
---|
[ac9552f] | 150 |
|
---|
| 151 | <para>
|
---|
| 152 | If you have <xref linkend="doxygen"/> installed and wish to build the
|
---|
| 153 | API documentation, execute the following commands (as the
|
---|
| 154 | <systemitem class="username">root</systemitem> user):
|
---|
| 155 | </para>
|
---|
| 156 |
|
---|
| 157 | <screen role="root"><userinput>ninja doxygen &&
|
---|
[3833a14] | 158 | install -vDm644 -t /usr/share/doc/ninja-&ninja-version;/ doc/doxygen/html/*</userinput></screen>
|
---|
[ac9552f] | 159 |
|
---|
[114fd4e5] | 160 | </sect2>
|
---|
| 161 |
|
---|
| 162 | <sect2 role="commands">
|
---|
| 163 | <title>Command Explanations</title>
|
---|
| 164 |
|
---|
[ac9552f] | 165 | <para>
|
---|
| 166 | <command>emacs -Q --batch -f batch-byte-compile
|
---|
| 167 | misc/ninja-mode.el</command>: regenerates the emacs lisp files.
|
---|
| 168 | </para>
|
---|
[114fd4e5] | 169 |
|
---|
| 170 | </sect2>
|
---|
| 171 |
|
---|
| 172 | <sect2 role="content">
|
---|
| 173 | <title>Contents</title>
|
---|
| 174 |
|
---|
| 175 | <segmentedlist>
|
---|
| 176 | <segtitle>Installed Programs</segtitle>
|
---|
| 177 | <segtitle>Installed Library</segtitle>
|
---|
| 178 | <segtitle>Installed Directories</segtitle>
|
---|
| 179 |
|
---|
| 180 | <seglistitem>
|
---|
| 181 | <seg>
|
---|
| 182 | ninja
|
---|
| 183 | </seg>
|
---|
| 184 | <seg>
|
---|
| 185 | none
|
---|
| 186 | </seg>
|
---|
| 187 | <seg>
|
---|
[ac9552f] | 188 | /usr/share/doc/ninja-&ninja-version;
|
---|
[114fd4e5] | 189 | </seg>
|
---|
| 190 | </seglistitem>
|
---|
| 191 | </segmentedlist>
|
---|
| 192 |
|
---|
| 193 | <variablelist>
|
---|
| 194 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 195 | <?dbfo list-presentation="list"?>
|
---|
| 196 | <?dbhtml list-presentation="table"?>
|
---|
| 197 |
|
---|
| 198 | <varlistentry id="ninja-prog">
|
---|
| 199 | <term><command>ninja</command></term>
|
---|
| 200 | <listitem>
|
---|
| 201 | <para>
|
---|
| 202 | is the Ninja build system.
|
---|
| 203 | </para>
|
---|
| 204 | <indexterm zone="ninja ninja-prog">
|
---|
| 205 | <primary sortas="b-ninja">ninja</primary>
|
---|
| 206 | </indexterm>
|
---|
| 207 | </listitem>
|
---|
| 208 | </varlistentry>
|
---|
| 209 |
|
---|
| 210 | </variablelist>
|
---|
| 211 |
|
---|
| 212 | </sect2>
|
---|
| 213 |
|
---|
| 214 | </sect1>
|
---|