summaryrefslogtreecommitdiffstats
path: root/doc/generated/builders.gen
diff options
context:
space:
mode:
Diffstat (limited to 'doc/generated/builders.gen')
-rw-r--r--doc/generated/builders.gen27
1 files changed, 15 insertions, 12 deletions
diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen
index e21c782..ff3bb39 100644
--- a/doc/generated/builders.gen
+++ b/doc/generated/builders.gen
@@ -1247,31 +1247,34 @@ env.MSVSSolution(
<term><function>Ninja</function>()</term>
<term><replaceable>env</replaceable>.<methodname>Ninja</methodname>()</term>
<listitem><para>
- &b-Ninja; is a special builder which
- adds a target to create a ninja build file.
+ A special builder which
+ adds a target to create a Ninja build file.
The builder does not require any source files to be specified.
</para>
<note>
<para>This is an experimental feature. To enable it you must use one of the following methods
</para>
-<!-- NOTE DO NOT INDENT THE FOLLOWING AS IT WILL ALTER THE FORMATTING-->
+<!-- NOTE DO NOT INDENT example_commands CONTENTS AS IT WILL ALTER THE FORMATTING-->
<example_commands>
- # On the command line
- --experimental=ninja
+# On the command line
+--experimental=ninja
- # Or in your SConstruct
- SetOption('experimental', 'ninja')
+# Or in your SConstruct
+SetOption('experimental', 'ninja')
</example_commands>
<para>This functionality is subject to change and/or removal without deprecation cycle.</para>
-
<para>
- To use this tool you must install pypi's <ulink url="https://pypi.org/project/ninja/">ninja
- package</ulink>.
- This can be done via
- <command>pip install ninja</command>
+ To use this tool you need to install the &Python; &ninja; package,
+ as the tool by default depends on being able to do an
+ <systemitem>import</systemitem> of the package
+<!-- (although see &cv-link-__NINJA_NO;).-->
+ This can be done via:
+ <example_commands>
+python -m pip install ninja
+ </example_commands>
</para>
</note>