[Ada] Minor: improve comments

2019-12-16  Bob Duff  <duff@adacore.com>

gcc/ada/

	* errout.adb, errout.ads: Improve comments.

From-SVN: r279440

diff --git a/gcc/ada/ChangeLog b/gcc/ada/ChangeLog
index 9a422d812bcd184d3e64278e639c51400c33e60d..0f94e4047d180f8020da0766e8396d3883c22a33 100644 (file)
--- a/gcc/ada/ChangeLog
+++ b/gcc/ada/ChangeLog
@@ -1,3 +1,7 @@
+2019-12-16  Bob Duff  <duff@adacore.com>
+
+       * errout.adb, errout.ads: Improve comments.
+
 2019-12-16  Bob Duff  <duff@adacore.com>
 
        * sem_util.ads: Minor comment fix.

diff --git a/gcc/ada/errout.adb b/gcc/ada/errout.adb
index 46e223f8d69ecc6245c5a8d572e71a996da5386f..db3393c59f1dd7332c0cdd36697ae00b493d2d7c 100644 (file)
--- a/gcc/ada/errout.adb
+++ b/gcc/ada/errout.adb
@@ -1716,9 +1716,12 @@ package body Errout is
 
    function Is_Size_Too_Small_Message (S : String) return Boolean is
       Size_For : constant String := "size for";
+      pragma Assert (Size_Too_Small_Message (1 .. Size_For'Last) = Size_For);
+      --  Assert that Size_Too_Small_Message starts with Size_For
    begin
       return S'Length >= Size_For'Length
         and then S (S'First .. S'First + Size_For'Length - 1) = Size_For;
+      --  True if S starts with Size_For
    end Is_Size_Too_Small_Message;
 
    -----------------

diff --git a/gcc/ada/errout.ads b/gcc/ada/errout.ads
index 64acff496ca24e53f88f4e628b27d56aac476408..4cfb806d0e7767517a8ad010f221013b2586e57b 100644 (file)
--- a/gcc/ada/errout.ads
+++ b/gcc/ada/errout.ads
@@ -957,8 +957,9 @@ package Errout is
    function Is_Size_Too_Small_Message (S : String) return Boolean;
    Size_Too_Small_Message : constant String :=
      "size for& too small, minimum allowed is ^";
-   --  This message is explicitly tested in Special_Msg_Delete in the package
-   --  body, which is somewhat questionable, but at least by using a constant
-   --  we are obeying the DRY principle.
+   --  This message is printed in Freeze and Sem_Ch13. We also test for it in
+   --  the body of this package (see Special_Msg_Delete) ???which is somewhat
+   --  questionable. The Is_Size_Too_Small_Message function tests for it by
+   --  testing a prefix. The function and constant should be kept in synch.
 
 end Errout;