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