Updates to docs to indicate experimental status

2 files changed, 27 insertions, 22 deletions

diff --git a/SCons/Tool/ninja/__init__.py b/SCons/Tool/ninja/__init__.py
index eb66198..d940bb1 100644
--- a/SCons/Tool/ninja/__init__.py
+++ b/SCons/Tool/ninja/__init__.py
@@ -437,13 +437,14 @@ def generate(env):
     # Set all three environment variables that Python's
     # tempfile.mkstemp looks at as it behaves differently on different
     # platforms and versions of Python.
-    build_dir = env.subst("$NINJA_DIR")
-    if build_dir == "":
-        build_dir = "."
-    os.environ["TMPDIR"] = env.Dir("{}/.response_files".format(build_dir)).get_abspath()
-    os.environ["TEMP"] = os.environ["TMPDIR"]
-    os.environ["TMP"] = os.environ["TMPDIR"]
-    if not os.path.isdir(os.environ["TMPDIR"]):
-        env.Execute(SCons.Defaults.Mkdir(os.environ["TMPDIR"]))
-
+    # build_dir = env.subst("$NINJA_DIR")
+    # if build_dir == "":
+    #     build_dir = "."
+    # os.environ["TMPDIR"] = env.Dir("{}/.response_files".format(build_dir)).get_abspath()
+    # os.environ["TEMP"] = os.environ["TMPDIR"]
+    # os.environ["TMP"] = os.environ["TMPDIR"]
+    # if not os.path.isdir(os.environ["TMPDIR"]):
+    #     env.Execute(SCons.Defaults.Mkdir(os.environ["TMPDIR"]))
+
+    env['TEMPFILEDIR'] = "$NINJA_DIR/.response_files"
     env["TEMPFILE"] = NinjaNoResponseFiles
diff --git a/SCons/Tool/ninja/ninja.xml b/SCons/Tool/ninja/ninja.xml
index 8bcfe1c..eaed82a 100644
--- a/SCons/Tool/ninja/ninja.xml
+++ b/SCons/Tool/ninja/ninja.xml
@@ -50,9 +50,11 @@ See its __doc__ string for a discussion of the format.
             <para>
                 Sets up &b-link-Ninja; builder which generates a ninja build file, and then optionally runs ninja.
             </para>
-            <para>NOTE: This is an experimental feature. You'll need to pass scons --experimental=ninja to enable.
-            </para>
-            <para>NOTE: This functionality is subject to change and/or removal without deprecation cycle.</para>
+            <note>
+                <para>This is an experimental feature.
+                </para>
+                <para>This functionality is subject to change and/or removal without deprecation cycle.</para>
+            </note>
 
         </summary>
         <sets>
@@ -73,11 +75,11 @@ See its __doc__ string for a discussion of the format.
 
 
             <!-- TODO: Document these -->
-            <item>NINJA_RULES</item>
-            <item>NINJA_POOLS</item>
-            <item>NINJA</item>
-            <item>GENERATING_NINJA</item>
-            <item>NINJA_DIR</item>
+            <!--            <item>NINJA_RULES</item>-->
+            <!--            <item>NINJA_POOLS</item>-->
+            <!--            <item>NINJA</item>-->
+            <!--            <item>GENERATING_NINJA</item>-->
+            <!--            <item>NINJA_DIR</item>-->
 
         </sets>
 
@@ -102,13 +104,13 @@ See its __doc__ string for a discussion of the format.
             <item>SHLINKCOM</item>
             <item>PROGSUFFIX</item>
             <item>PRINT_CMD_LINE_FUNC</item>
-            <item>TEMPFILE</item>
+            <!--            <item>TEMPFILE</item>-->
 
-            <!-- TODO: Document these -->
+            <!-- TODO: Document these
             <item>NINJA_MAX_JOBS</item>
             <item>NINJA_SKIP</item>
             <item>NINJA_CUSTOM_HANDLERS</item>
-
+-->
 
         </uses>
     </tool>
@@ -121,9 +123,8 @@ See its __doc__ string for a discussion of the format.
                 The builder does not require any source files to be specified,
             </para>
             <note>
-                <para>This is an experimental feature. You'll need to pass scons --experimental=ninja to enable.
+                <para>This is an experimental feature. To enable it you must use one of the following methods
                 </para>
-                <para>This functionality is subject to change and/or removal without deprecation cycle.</para>
 
                 <example_commands>
                     # On the command line
@@ -133,6 +134,9 @@ See its __doc__ string for a discussion of the format.
                     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>.