Issue 2349: doc-only change correcting description of text returned from sconf.Result() call

4 files changed, 9 insertions, 10 deletions

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 240972c..facfd9c 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -7182,8 +7182,8 @@ will be displayed to the user, e.g. 'Checking for library X...'
 
 Usually called after the check is done.
 .I res
-can be either an integer or a string. In the former case, 'ok' (res != 0)
-or 'failed' (res == 0) is displayed to the user, in the latter case the
+can be either an integer or a string. In the former case, 'yes' (res != 0)
+or 'no' (res == 0) is displayed to the user, in the latter case the
 given string is displayed.
 
 .TP
diff --git a/doc/user/sconf.in b/doc/user/sconf.in
index 0ef1d85..8ac4530 100644
--- a/doc/user/sconf.in
+++ b/doc/user/sconf.in
@@ -306,8 +306,8 @@
     the &Message; call prints the
     specified message (with no trailing newline)
     and the &Result; call prints
-    <literal>ok</literal> if the check succeeds and
-    <literal>failed</literal> if it doesn't.
+    <literal>yes</literal> if the check succeeds and
+    <literal>no</literal> if it doesn't.
     The &TryLink; method
     actually tests for whether the
     specified program text
@@ -435,7 +435,7 @@
 
     <screen>
     % <userinput>scons -Q -c</userinput>
-    Checking for MyLibrary... ok
+    Checking for MyLibrary... yes
     Removed foo.o
     Removed foo
     </screen>
diff --git a/doc/user/sconf.xml b/doc/user/sconf.xml
index d89470d..b6e02eb 100644
--- a/doc/user/sconf.xml
+++ b/doc/user/sconf.xml
@@ -306,8 +306,8 @@
     the &Message; call prints the
     specified message (with no trailing newline)
     and the &Result; call prints
-    <literal>ok</literal> if the check succeeds and
-    <literal>failed</literal> if it doesn't.
+    <literal>yes</literal> if the check succeeds and
+    <literal>no</literal> if it doesn't.
     The &TryLink; method
     actually tests for whether the
     specified program text
@@ -435,7 +435,7 @@
 
     <screen>
     % <userinput>scons -Q -c</userinput>
-    Checking for MyLibrary... ok
+    Checking for MyLibrary... yes
     Removed foo.o
     Removed foo
     </screen>
diff --git a/src/engine/SCons/SConf.py b/src/engine/SCons/SConf.py
index 38b3ddb..5d671d2 100644
--- a/src/engine/SCons/SConf.py
+++ b/src/engine/SCons/SConf.py
@@ -784,8 +784,7 @@ class CheckContext:
 
     def Result(self, res):
         """Inform about the result of the test. res may be an integer or a
-        string. In case of an integer, the written text will be 'ok' or
-        'failed'.
+        string. In case of an integer, the written text will be 'yes' or 'no'.
         The result is only displayed when self.did_show_result is not set.
         """
         if type(res) in BooleanTypes: