[m-rev.] trivial diff: documentation fixes

Julien Fischer juliensf at cs.mu.OZ.AU
Tue Oct 11 13:15:51 AEST 2005


Estimated hours taken: 0.4
Branches: main

util/mkinit.c:
	Update the comments to reflect the fact that mlds_to_c.m
	also generates ENDINIT comments.

	Fix a typo.

README.MinGW:
library/io.m:
library/store.m:
runtime/mercury.h:
runtime/mercry_wrapper.c:
	Fix a bunch of typos.

Julien.

Index: README.MinGW
===================================================================
RCS file: /home/mercury1/repository/mercury/README.MinGW,v
retrieving revision 1.1
diff -u -r1.1 README.MinGW
--- README.MinGW	4 Oct 2005 10:34:36 -0000	1.1
+++ README.MinGW	10 Oct 2005 08:58:09 -0000
@@ -33,7 +33,7 @@
     will be interpreted differently by the MSYS shell than by the generated
     executables, resulting in a broken installation.
     On Windows 2000 or XP, you may get a dialog from the
-    "Micrsoft Management Console" with the message "The selected file cannot
+    "Microsoft Management Console" with the message "The selected file cannot
     be found.".  This is because configure looks for a program called "mmc".
     Simply dismiss the dialog by clicking OK.

Index: library/io.m
===================================================================
RCS file: /home/mercury1/repository/mercury/library/io.m,v
retrieving revision 1.334
diff -u -r1.334 io.m
--- library/io.m	22 Sep 2005 06:17:26 -0000	1.334
+++ library/io.m	10 Oct 2005 08:42:03 -0000
@@ -128,7 +128,7 @@
     %
 :- pred io__read_word(io__result(list(char))::out, io::di, io::uo) is det.

-    % Reads a line from the current input stream, returns the the result
+    % Reads a line from the current input stream, returns the result
     % as a list of chars.
     %
 :- pred io__read_line(io__result(list(char))::out, io::di, io::uo) is det.
@@ -1664,7 +1664,7 @@
     % Reads a character from specified stream, and returns the numerical value
     % for that character (as from char__to_int). This may involve converting
     % external character encodings into Mercury's internal character
-    % repesentation and (for text streams) converting OS line indicators,
+    % representation and (for text streams) converting OS line indicators,
     % e.g. CR-LF for Windows, to '\n' characters. Returns -1 if at EOF,
     % -2 if an error occurs.
     %
@@ -5074,7 +5074,7 @@

         /*
         ** This constructor handles binary files (in or out) but does
-        ** not cover mercury_stdin_binary/mecury_stdout_binary.
+        ** not cover mercury_stdin_binary/mercury_stdout_binary.
         */
         public MR_MercuryFileStruct(java.lang.String file, char mode) {
             id = ML_next_stream_id++;
Index: library/store.m
===================================================================
RCS file: /home/mercury1/repository/mercury/library/store.m,v
retrieving revision 1.48
diff -u -r1.48 store.m
--- library/store.m	16 Jun 2005 04:08:05 -0000	1.48
+++ library/store.m	10 Oct 2005 08:38:17 -0000
@@ -195,9 +195,8 @@
 % Nasty performance hacks
 %
 % WARNING: use of these procedures is dangerous!
-% Use them only only as a last resort, only if performance
-% is critical, and only if profiling shows that using the
-% safe versions is a bottleneck.
+% Use them only as a last resort, only if performance is critical, and only if
+% profiling shows that using the safe versions is a bottleneck.
 %
 % These procedures may vanish in some future version of Mercury.

Index: runtime/mercury.h
===================================================================
RCS file: /home/mercury1/repository/mercury/runtime/mercury.h,v
retrieving revision 1.70
diff -u -r1.70 mercury.h
--- runtime/mercury.h	16 Sep 2005 14:48:39 -0000	1.70
+++ runtime/mercury.h	10 Oct 2005 08:49:48 -0000
@@ -113,7 +113,7 @@

 /*---------------------------------------------------------------------------*/
 /*
-** Declarations of contants and variables
+** Declarations of constants and variables
 */

 #ifdef MR_NATIVE_GC
Index: runtime/mercury_wrapper.c
===================================================================
RCS file: /home/mercury1/repository/mercury/runtime/mercury_wrapper.c,v
retrieving revision 1.156
diff -u -r1.156 mercury_wrapper.c
--- runtime/mercury_wrapper.c	29 Sep 2005 06:33:15 -0000	1.156
+++ runtime/mercury_wrapper.c	10 Oct 2005 08:54:34 -0000
@@ -1819,7 +1819,7 @@
 	**   {
 	**   }
 	**
-	** This type of contruction allows us to retrieve all the information
+	** This type of construction allows us to retrieve all the information
 	** we need (exception type, address, etc) to display a "meaningful"
 	** message to the user.  Using signal() in Win32 is less powerful,
 	** since we can only trap a subset of all possible exceptions, and
@@ -1993,7 +1993,7 @@
 		** We can compare pointers instead of using strcmp,
 		** because the pointers in the array come from the
 		** type_ctor_infos themselves, and there is only one
-		** static type_ctor_info for each modulename:typename
+		** static type_ctor_info for each modulename.typename
 		** combination.
 		*/

Index: util/mkinit.c
===================================================================
RCS file: /home/mercury1/repository/mercury/util/mkinit.c,v
retrieving revision 1.106
diff -u -r1.106 mkinit.c
--- util/mkinit.c	4 Oct 2005 23:48:34 -0000	1.106
+++ util/mkinit.c	11 Oct 2005 03:13:47 -0000
@@ -237,7 +237,7 @@
 #define MR_INIT_REQ_MODULE_SIZE     10

 /*
-** List of names of modules that have finialisation function that should
+** List of names of modules that have finalisation functions that should
 ** always be run.  We call a "final_required" function for each such module.
 */
 static const char   **req_final_modules = NULL;
@@ -1170,8 +1170,8 @@
     ** (INIT, REQUIRED_INIT, REQUIRED_FINAL, and ADITI_DATA) should end with
     ** the space that separates the keyword from the following data.
     ** The string that is not supposed to be following by other information
-    ** (ENDINIT) should not have a following space, since llds_out.m doesn't
-    ** add that space.
+    ** (ENDINIT) should not have a following space, since llds_out.m and
+    ** mlds_to_c.m do not add that space.
     */

     const char * const  init_str = "INIT ";

--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------



More information about the reviews mailing list