[Ada] Various typo fixes and reformatting of comments
authorGary Dismukes <dismukes@adacore.com>
Thu, 7 May 2020 18:58:33 +0000 (14:58 -0400)
committerPierre-Marie de Rodat <derodat@adacore.com>
Mon, 6 Jul 2020 11:35:23 +0000 (07:35 -0400)
gcc/ada/

* doc/gnat_rm/implementation_defined_pragmas.rst, errout.ads,
erroutc.adb, exp_ch4.adb, exp_ch6.adb, freeze.adb: Comment
rewording/reformatting/typo fixes.  Replace "ie." with "that is"
in comment; "can not" -> "cannot", and remove an extraneous
underscore in another comment.
* gnat_rm.texi, gnat_ugn.texi: Regenerate.

gcc/ada/doc/gnat_rm/implementation_defined_pragmas.rst
gcc/ada/errout.ads
gcc/ada/erroutc.adb
gcc/ada/exp_ch4.adb
gcc/ada/exp_ch6.adb
gcc/ada/freeze.adb
gcc/ada/gnat_rm.texi
gcc/ada/gnat_ugn.texi

index d100b2259d8a6cf90f1fc4f6228fe1c005dd963b..2f60db506bfe0bc2e799db0f6f12d1a68e1e10bd 100644 (file)
@@ -982,9 +982,9 @@ with a first parameter of True is to warn a client about use of a package,
 for example that it is not fully implemented.
 
 In previous versions of the compiler, combining *-gnatwe* with
-Compile_Time_Warning resulted in an fatal error. Now the compiler will always
-emit a warning. You can use :ref:`Compile_Time_Error` to force the generation
-of an error.
+Compile_Time_Warning resulted in a fatal error. Now the compiler always emits
+a warning. You can use :ref:`Compile_Time_Error` to force the generation of
+an error.
 
 Pragma Compiler_Unit
 ====================
index 68fcdb94d4fc02dc323f2520ebbf4ad6b3561bbc..1591a3712f554a5c452bc314da093706f49b147b 100644 (file)
@@ -705,8 +705,8 @@ package Errout is
       Flag_Location          : Source_Ptr;
       Is_Compile_Time_Pragma : Boolean);
    --  Same as Error_Msg (String, Source_Ptr) except Is_Compile_Time_Pragma
-   --  lets the caller specify whether the is a
-   --  Compile_Time_Warning/Compile_Time_Error pragma.
+   --  lets the caller specify whether this is a Compile_Time_Warning or
+   --  Compile_Time_Error pragma.
 
    procedure Error_Msg_S (Msg : String);
    --  Output a message at current scan pointer location. This routine can be
index 14e2aad8b30071c920f6da64ee4fb48e4910658f..435cb143abe8bbcf940e3c9f3166739bd9f96f5d 100644 (file)
@@ -258,12 +258,12 @@ package body Erroutc is
       elsif Warnings_Treated_As_Errors /= 0 then
          return True;
 
-         --  We should never treat warnings that originate from a
-         --  Compile_Time_Warning pragma as an error. Warnings_Count is the sum
-         --  of both "normal" and Compile_Time_Warning warnings. This means
-         --  that there only is one or more non-Compile_Time_Warning warnings
-         --  if Warnings_Count is greater than
-         --  Count_Compile_Time_Pragma_Warnings.
+      --  We should never treat warnings that originate from a
+      --  Compile_Time_Warning pragma as an error. Warnings_Count is the sum
+      --  of both "normal" and Compile_Time_Warning warnings. This means that
+      --  there are only one or more non-Compile_Time_Warning warnings when
+      --  Warnings_Count is greater than Count_Compile_Time_Pragma_Warnings.
+
       elsif Warning_Mode = Treat_As_Error
          and then Warnings_Count > Count_Compile_Time_Pragma_Warnings
       then
index 88dcb52349d43d40ff91d99214b7e2afe525fc52..05c635f94121e77574dd619bac412c1f7ae5310d 100644 (file)
@@ -226,8 +226,8 @@ package body Exp_Ch4 is
 
    procedure Narrow_Large_Operation (N : Node_Id);
    --  Try to compute the result of a large operation in a narrower type than
-   --  its nominal type. This is mainly aimed to get rid of operations done in
-   --  Universal_Integer that can be generated for attributes.
+   --  its nominal type. This is mainly aimed at getting rid of operations done
+   --  in Universal_Integer that can be generated for attributes.
 
    procedure Optimize_Length_Comparison (N : Node_Id);
    --  Given an expression, if it is of the form X'Length op N (or the other
@@ -14040,12 +14040,12 @@ package body Exp_Ch4 is
       --  Now compute the size of the narrower type
 
       if Compar then
-         --  The type must be able to accomodate the operands
+         --  The type must be able to accommodate the operands
 
          Nsiz := Nat'Max (Lsiz, Rsiz);
 
       else
-         --  The type must be able to accomodate the operand(s) and the result.
+         --  The type must be able to accommodate the operand(s) and result.
 
          --  Note that Determine_Range typically does not report the bounds of
          --  the value as being larger than those of the base type, which means
@@ -14090,7 +14090,7 @@ package body Exp_Ch4 is
          return;
       end if;
 
-      --  Finally rewrite the operation in the narrower type
+      --  Finally, rewrite the operation in the narrower type
 
       Nop := New_Op_Node (Kind, Sloc (N));
 
index 92be80287a697465c195284f9451bfb46e15273b..d29040b30228ca6ef959a5bb3f64133109dc67dc 100644 (file)
@@ -9982,8 +9982,8 @@ package body Exp_Ch6 is
       --  to ensure that if Func_Id is frozen then the computed result matches
       --  with the availability of the task master extra formal; unfortunately
       --  this is not feasible because we may be precisely freezing this entity
-      --  (ie. Is_Frozen has been set by Freeze_Entity but it has not completed
-      --  its work).
+      --  (that is, Is_Frozen has been set by Freeze_Entity but it has not
+      --  completed its work).
 
       if Has_Task (Func_Typ) then
          return True;
@@ -9992,9 +9992,9 @@ package body Exp_Ch6 is
          return Might_Have_Tasks (Func_Typ);
 
       --  Handle subprogram type internally generated for dispatching call. We
-      --  can not rely on the return type of the subprogram type of dispatching
+      --  cannot rely on the return type of the subprogram type of dispatching
       --  calls since it is always a class-wide type (cf. Expand_Dispatching_
-      --  _Call).
+      --  Call).
 
       elsif Ekind (Func_Id) = E_Subprogram_Type then
          if Is_Dispatch_Table_Entity (Func_Id) then
index 57b48941c37cad0c073e5c00adf522522528a6dd..7df283a32c4434bd660ea458bdbdc9f30e3acae2 100644 (file)
@@ -8726,8 +8726,8 @@ package body Freeze is
             return True;
          end if;
 
-         --  Check attribute Extra_Formal: if available it must be set only
-         --  in the last formal of E
+         --  Check attribute Extra_Formal: If available, it must be set only
+         --  on the last formal of E.
 
          Formal := First_Formal (E);
          while Present (Formal) loop
@@ -8752,15 +8752,15 @@ package body Freeze is
             return False;
          end if;
 
-         --  Check attribute Extra_Formals: if E has extra formals then this
-         --  attribute must must point to the first extra formal of E.
+         --  Check attribute Extra_Formals: If E has extra formals, then this
+         --  attribute must point to the first extra formal of E.
 
          if Has_Extra_Formals then
             return Present (Extra_Formals (E))
               and then Present (Extra_Formal (Last_Formal))
               and then Extra_Formal (Last_Formal) = Extra_Formals (E);
 
-         --  When E has no formals the first extra formal is available through
+         --  When E has no formals, the first extra formal is available through
          --  the Extra_Formals attribute.
 
          elsif Present (Extra_Formals (E)) then
@@ -8908,9 +8908,9 @@ package body Freeze is
       if not Has_Foreign_Convention (E) then
          if No (Extra_Formals (E)) then
 
-            --  Extra formals are shared by derived subprograms; therefore if
+            --  Extra formals are shared by derived subprograms; therefore, if
             --  the ultimate alias of E has been frozen before E then the extra
-            --  formals have been added but the attribute Extra_Formals is
+            --  formals have been added, but the attribute Extra_Formals is
             --  still unset (and must be set now).
 
             if Present (Alias (E))
index d72f905a2dfee92c7d7584d5de99094bb400968e..0f6109e6a96bb93d35fb6cd2d1c3b710ba4c9068 100644 (file)
@@ -21,7 +21,7 @@
 
 @copying
 @quotation
-GNAT Reference Manual , May 14, 2020
+GNAT Reference Manual , Jul 01, 2020
 
 AdaCore
 
@@ -2361,9 +2361,9 @@ with a first parameter of True is to warn a client about use of a package,
 for example that it is not fully implemented.
 
 In previous versions of the compiler, combining @emph{-gnatwe} with
-Compile_Time_Warning resulted in an fatal error. Now the compiler will always
-emit a warning. You can use @ref{3a,,Pragma Compile_Time_Error} to force the generation
-of an error.
+Compile_Time_Warning resulted in a fatal error. Now the compiler always emits
+a warning. You can use @ref{3a,,Pragma Compile_Time_Error} to force the generation of
+an error.
 
 @node Pragma Compiler_Unit,Pragma Compiler_Unit_Warning,Pragma Compile_Time_Warning,Implementation Defined Pragmas
 @anchor{gnat_rm/implementation_defined_pragmas pragma-compiler-unit}@anchor{3c}
index 669199aefcec9907dc797832d6d3b876dd59e5ed..b6ed321466c1372703f13dbff07b635775decfbb 100644 (file)
@@ -21,7 +21,7 @@
 
 @copying
 @quotation
-GNAT User's Guide for Native Platforms , May 05, 2020
+GNAT User's Guide for Native Platforms , Jul 01, 2020
 
 AdaCore
 
@@ -4144,10 +4144,9 @@ to be a consideration.
 @geindex Run-Time Library
 @geindex rebuilding
 
-It may be useful to recompile the GNAT library in various contexts, the
-most important one being the use of partition-wide configuration pragmas
-such as @code{Normalize_Scalars}. A special Makefile called
-@code{Makefile.adalib} is provided to that effect and can be found in
+It may be useful to recompile the GNAT library in various debugging or
+experimentation contexts. A project file called
+@code{libada.gpr} is provided to that effect and can be found in
 the directory containing the GNAT library. The location of this
 directory depends on the way the GNAT environment has been installed and can
 be determined by means of the command:
@@ -4156,10 +4155,13 @@ be determined by means of the command:
 $ gnatls -v
 @end example
 
-The last entry in the object search path usually contains the
-gnat library. This Makefile contains its own documentation and in
-particular the set of instructions needed to rebuild a new library and
-to use it.
+The last entry in the source search path usually contains the
+gnat library (the @code{adainclude} directory). This project file contains its
+own documentation and in particular the set of instructions needed to rebuild a
+new library and to use it.
+
+Note that rebuilding the GNAT Run-Time is only recommended for temporary
+experiments or debugging, and is not supported.
 
 @geindex Conditional compilation