[m-rev.] diff: fix documentation errors

Julien Fischer jfischer at opturion.com
Wed Mar 19 13:17:34 AEDT 2014


Branches: 14.01, master
---------------------

Fix some documentation errors.

library/getopt.m
library/getopt_io.m:
 	The first argument of the long_option predicate is a string,
 	not a character (as the comment in getopt.m as said since
 	1996!)

README.MS-VisualC:
 	Fix a doubled-up word.

Julien.

diff --git a/README.MS-VisualC b/README.MS-VisualC
index cbea002..54931ae 100644
--- a/README.MS-VisualC
+++ b/README.MS-VisualC
@@ -148,7 +148,7 @@ The MSVC port currently has a number of limitation:
  * Creation of shared libraries (DLLs) is not currently supported.

  * The '--c-debug' option currently has no effect with MSVC since enabling
-  it breaks parallel builds and and disables some C compiler optimizations.
+  it breaks parallel builds and disables some C compiler optimizations.

    If you *really* want to enable support for C level debugging, then enable the
    commented out definition of DEBUG_OPTS in scripts/mgnuc.in (in the "cl" case)
diff --git a/library/getopt.m b/library/getopt.m
index 6287e3b..c538bcf 100644
--- a/library/getopt.m
+++ b/library/getopt.m
@@ -115,7 +115,7 @@
  %   True if the character names a valid single-character option.
  %
  % :- pred long_option(string::in, option::out) is semidet.
-%   True if the character names a valid long option.
+%   True if the string names a valid long option.
  %
  % :- pred option_default(option::out, option_data::out) is multi.
  %   Nondeterministically returns all the options with their
diff --git a/library/getopt_io.m b/library/getopt_io.m
index 84ea522..2f45ccf 100644
--- a/library/getopt_io.m
+++ b/library/getopt_io.m
@@ -120,7 +120,7 @@
  %   True if the character names a valid single-character option.
  %
  % :- pred long_option(string::in, option::out) is semidet.
-%   True if the character names a valid long option.
+%   True if the string names a valid long option.
  %
  % :- pred option_default(option::out, option_data::out) is multi.
  %   Nondeterministically returns all the options with their



More information about the reviews mailing list