2005-09-01 Robert Dewar <dewar@adacore.com>

	    Arnaud Charlet  <charlet@adacore.com>

	* g-dirope.ads: Minor reformatting
	Document that bounds of result of Base_Name match the input index
	positions.
	Add documentation on environment variable syntax for Expand_Path

	* gnat_ugn.texi: Update documentation to include mention of -m switches
	Document new treatment of wide characters in max line length
	style check.
	Remove -gnatL/-gnatZ switches, no longer used.
	Add note on pragmas Assertion_Policy and Debug_Policy in discussion
	of -gnata switch.

	* gnat_rm.texi: Add doc for two argument form of pragma
	Float_Representation.
	Add documentation for pragma No_Strict_Aliasing
	Add note that explicit component clause overrides pragma Pack.
	Add documentation of pragma Debug_Policy


git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@103891 138bc75d-0d04-0410-961f-82ee72b054a4

1 files changed, 45 insertions, 33 deletions

diff --git a/gcc/ada/g-dirope.ads b/gcc/ada/g-dirope.ads
index 83ad41c33d7..226c593cc74 100644
--- a/gcc/ada/g-dirope.ads
+++ b/gcc/ada/g-dirope.ads
@@ -6,7 +6,7 @@
 --                                                                          --
 --                                 S p e c                                  --
 --                                                                          --
---            Copyright (C) 1998-2004 Ada Core Technologies, Inc.           --
+--            Copyright (C) 1998-2005 Ada Core Technologies, Inc.           --
 --                                                                          --
 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
 -- terms of the  GNU General Public License as published  by the Free Soft- --
@@ -94,7 +94,7 @@ package GNAT.Directory_Operations is
    --  Dir_Name. Raises Directory_Error if Dir_Name cannot be removed.
 
    function Get_Current_Dir return Dir_Name_Str;
-   --  Returns the current working directory for the execution environment.
+   --  Returns the current working directory for the execution environment
 
    procedure Get_Current_Dir (Dir : out Dir_Name_Str; Last : out Natural);
    --  Returns the current working directory for the execution environment
@@ -137,6 +137,10 @@ package GNAT.Directory_Operations is
    --  The comparison of Suffix is case-insensitive on systems such as Windows
    --  and VMS where the file search is case-insensitive (e.g. on such systems,
    --  Base_Name ("/Users/AdaCore/BB12.patch", ".Patch") returns "BB12").
+   --
+   --  Note that the index bounds of the result match the corresponding indexes
+   --  in the Path string (you cannot assume that the lower bound of the
+   --  returned string is one).
 
    function File_Extension (Path : Path_Name) return String;
    --  Return the file extension. This is defined as the string after the
@@ -150,16 +154,7 @@ package GNAT.Directory_Operations is
    --  path information. This is equivalent to Base_Name with default Extension
    --  value.
 
-   type Path_Style is
-     (UNIX,
-      --  Use '/' as the directory separator. The default on Unix systems
-      --  and on OpenVMS.
-
-      DOS,
-      --  Use '\' as the directory separator. The default on Windows.
-
-      System_Default);
-
+   type Path_Style is (UNIX, DOS, System_Default);
    function Format_Pathname
      (Path  : Path_Name;
       Style : Path_Style := System_Default) return Path_Name;
@@ -168,26 +163,20 @@ package GNAT.Directory_Operations is
    --  function will help to provide a consistent naming scheme running for
    --  different environments. If style is set to System_Default the routine
    --  will use the default directory separator on the running environment.
+   --
+   --  The Style argument indicates the syntax to be used for path names:
+   --
+   --    UNIX
+   --      Use '/' as the directory separator. The default on Unix systems
+   --      and on OpenVMS.
+   --
+   --    DOS
+   --      Use '\' as the directory separator. The default on Windows.
+   --
+   --    System_Default
+   --      Use the default style for the current system
 
-   type Environment_Style is
-     (UNIX,
-      --  Environment variables and OpenVMS logical names use $ as prefix and
-      --  can use curly brackets as in ${HOME}/mydir. If there is no closing
-      --  curly bracket for an opening one then translation is done, so for
-      --  example ${VAR/toto is returned as ${VAR/toto.
-
-      DOS,
-      --  Environment variables uses % as prefix and suffix
-      --  (e.g. %HOME%/mydir). The name DOS refer to "DOS-like" environment.
-      --  This includes al Windows systems.
-
-      Both,
-      --  Recognize both forms described above.
-
-      System_Default);
-      --  Uses either UNIX on Unix and OpenVMS systems, or DOS on Windows and
-      --  OS/2 depending on the running environment.
-
+   type Environment_Style is (UNIX, DOS, Both, System_Default);
    function Expand_Path
      (Path : Path_Name;
       Mode : Environment_Style := System_Default) return Path_Name;
@@ -198,6 +187,29 @@ package GNAT.Directory_Operations is
    --  variable does not exists the variable will be replaced by the empty
    --  string. Two dollar or percent signs are replaced by a single
    --  dollar/percent sign. Note that a variable must start with a letter.
+   --
+   --  The Mode argument indicates the recognized syntax for environment
+   --  variables as follows:
+   --
+   --    UNIX
+   --      Environment variables and OpenVMS logical names use $ as prefix and
+   --      can use curly brackets as in ${HOME}/mydir. If there is no closing
+   --      curly bracket for an opening one then no translation is done, so for
+   --      example ${VAR/toto is returned as ${VAR/toto. The use of {} brackets
+   --      is required if the environment variable name contains other than
+   --      alphanumeric characters.
+   --
+   --    DOS
+   --      Environment variables uses % as prefix and suffix (e.g. %HOME%/dir).
+   --      The name DOS refer to "DOS-like" environment. This includes all
+   --      Windows systems.
+   --
+   --    Both
+   --      Recognize both forms described above.
+   --
+   --    System_Default
+   --      Uses either UNIX on Unix and OpenVMS systems, or DOS on Windows and
+   --      OS/2 depending on the running environment.
 
    ---------------
    -- Iterators --
@@ -215,7 +227,7 @@ package GNAT.Directory_Operations is
    --  Raises Directory_Error if Dir has not be opened (Dir = Null_Dir).
 
    function Is_Open (Dir : Dir_Type) return Boolean;
-   --  Returns True if Dir is open, or False otherwise.
+   --  Returns True if Dir is open, or False otherwise
 
    procedure Read
      (Dir  : in out Dir_Type;
@@ -251,6 +263,6 @@ private
 
    Dir_Seps : constant Ada.Strings.Maps.Character_Set :=
                 Ada.Strings.Maps.To_Set ("/\");
-   --  UNIX and DOS style directory separators.
+   --  UNIX and DOS style directory separators
 
 end GNAT.Directory_Operations;