Re: document path separator

[Ralf Wildenhues]

* Gary V. Vaughan wrote on Fri, Nov 19, 2004 at 06:20:24AM CET:
> Bob Friesenhahn wrote:
> >On Wed, 17 Nov 2004, Ralf Wildenhues wrote:
> >
> >>OK to apply to HEAD and branch-2-0? (wording may be suboptimal).
> 
> This would also be a good place to note that #including ltdl.h will
> define LT_PATHSEP_CHAR to ':' or ';' and in addition will set 
> LT_DIRSEP_CHAR to '\' if that character is a valid additional directory
> separator ('/' is a directory separator in either case).

Merci.
OK to apply?

BTW, is LT_SCOPE supposed to be public as well?
(Note that I am still not convinced that it is sufficient to only have
one such macro, looking at the MinGW desaster).


2004-11-19  Ralf Wildenhues <address@hidden>

        * doc/libtool.texi (Libltdl interface): Document public macros
        LT_PATHSEP_CHAR, LT_DIRSEP_CHAR, use in path descriptions.


Index: doc/libtool.texi
===================================================================
RCS file: /cvsroot/libtool/libtool/doc/libtool.texi,v
retrieving revision 1.181
diff -u -r1.181 libtool.texi
--- doc/libtool.texi    17 Nov 2004 17:49:44 -0000      1.181
+++ doc/libtool.texi    19 Nov 2004 06:53:54 -0000
@@ -3354,6 +3354,21 @@
 welcome.
 
 @noindent
+The following macros are defined by including @file{ltdl.h}:
+
address@hidden {Macro} LT_PATHSEP_CHAR
address@hidden is the system-dependent path separator,
+that is, @code{;} on Windows and @code{:} everywhere else.
address@hidden defmac
+
address@hidden {Macro} LT_DIRSEP_CHAR
+If @code{LT_DIRSEP_CHAR} is defined, it can be used as directory
+separator in addition to @code{/}.  On Windows, this contains
address@hidden
address@hidden defmac
+
+
address@hidden
 The following types are defined in @file{ltdl.h}:
 
 @deftp {Type} lt_ptr
@@ -3429,10 +3444,9 @@
 (e.g. on Linux it is @var{LD_LIBRARY_PATH}).
 @end enumerate
 
-Each search path must be a colon-separated list of absolute directories,
-for example, @code{"/usr/lib/mypkg:/lib/foo"}.  On Windows, the path
-separator is a semi-colon.  The directory names may not contain the
-path separator.
+Each search path must be a list of absolute directories separated by
address@hidden, for example, @code{"/usr/lib/mypkg:/lib/foo"}.
+The directory names may not contain the path separator.
 
 If the same module is loaded several times, the same handle is returned.
 If @code{lt_dlopen} fails for any reason, it returns @code{NULL}.
@@ -3489,8 +3503,8 @@
 
 @deftypefun int lt_dlsetsearchpath (const char address@hidden)
 Replace the current user-defined library search path with
address@hidden, which must be a colon-separated (semi-colon on Windows) list
-of absolute directories.  Return 0 on success.
address@hidden, which must be a list of absolute directories separated
+by @code{LT_PATHSEP_CHAR}.  Return 0 on success.
 @end deftypefun
 
 @deftypefun {const char *}lt_dlgetsearchpath (void)
@@ -3501,8 +3515,8 @@
 In some applications you may not want to load individual modules with
 known names, but rather find all of the modules in a set of
 directories and load them all during initialisation.  With this function
-you can have libltdl scan the colon delimited directory list (semi-colon on
-Windows) in @var{search_path} for candidates, and pass them, along with
+you can have libltdl scan the @code{LT_PATHSEP_CHAR}-delimited directory list
+in @var{search_path} for candidates, and pass them, along with
 @var{data} to your own callback function, @var{func}.  If @var{seach_path} is
 @samp{NULL}, then search all of the standard locations that
 @code{lt_dlopen} would examine.  This function will continue to make