manual: Improve documentation of get_current_dir_name. [BZ #6889]

This is a minor rewording to clarify the behaviour of
get_current_dir_name.  Additionally, the @vindex is moved above the
@deftypefun so that following links give a better result with regard
to context.

	[BZ #6889]
	* manual/filesys.texi (get_current_dir_name): Clarify
	behaviour.

(cherry picked from commit 7d15ef84f50a80cb170f8ce3457010f59e221cb8)

diff --git a/ChangeLog b/ChangeLog
index 8eb60784859d52fd59e586517174959f7c5cfbee..727b2f92c34353e1358c65a601668f99413f0595 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2018-02-19  Rical Jasan  <ricaljasan@pacific.net>
+
+       [BZ #6889]
+       * manual/filesys.texi (get_current_dir_name): Clarify behaviour.
+
 2018-02-16  Rical Jasan  <ricaljasan@pacific.net>
 
        * manual/platform.texi (__riscv_flush_icache): Fix @deftypefun

diff --git a/NEWS b/NEWS
index e40fa8d1df97a974feb471337e40229e0d4b68c7..5571c592bf1110c79432fb455caeb018d07f1f68 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -9,6 +9,7 @@ Version 2.27.1
 
 The following bugs are resolved with this release:
 
+  [6889] 'PWD' mentioned but not specified
   [22638] sparc: static binaries are broken if glibc is built by gcc
     configured with --enable-default-pie
   [22735] Misleading typo in time.h source comment regarding CLOCKS_PER_SECOND

diff --git a/manual/filesys.texi b/manual/filesys.texi
index ca77996902250bc9e525ad1ffff6901a61399fd9..cc70a6b7eebddc8d1c34d658592504c446579ad3 100644 (file)
--- a/manual/filesys.texi
+++ b/manual/filesys.texi
@@ -147,19 +147,20 @@ necessarily enough space to contain the directory name.  That is why
 this function is deprecated.
 @end deftypefn
 
+@vindex PWD
 @deftypefun {char *} get_current_dir_name (void)
 @standards{GNU, unistd.h}
 @safety{@prelim{}@mtsafe{@mtsenv{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{} @acsfd{}}}
 @c Besides getcwd, which this function calls as a fallback, it calls
 @c getenv, with the potential thread-safety issues that brings about.
-@vindex PWD
-This @code{get_current_dir_name} function is basically equivalent to
-@w{@code{getcwd (NULL, 0)}}.  The only difference is that the value of
-the @code{PWD} variable is returned if this value is correct.  This is a
-subtle difference which is visible if the path described by the
-@code{PWD} value is using one or more symbol links in which case the
-value returned by @code{getcwd} can resolve the symbol links and
-therefore yield a different result.
+The @code{get_current_dir_name} function is basically equivalent to
+@w{@code{getcwd (NULL, 0)}}, except the value of the @env{PWD}
+environment variable is first examined, and if it does in fact
+correspond to the current directory, that value is returned.  This is
+a subtle difference which is visible if the path described by the
+value in @env{PWD} is using one or more symbolic links, in which case
+the value returned by @code{getcwd} would resolve the symbolic links
+and therefore yield a different result.
 
 This function is a GNU extension.
 @end deftypefun