I've just done this and have changed coreutils to suit.
As far as I can see, no one else uses mreadlink_with_size.
Rename mreadlink_with_size to areadlink_with_size.
* NEWS: Document the change.
* lib/mreadlink-with-size.c (mreadlink_with_size): Rename this to...
* lib/areadlink-with-size.c (areadlink_with_size): ...this.
* lib/mreadlink.h: Rename this to...
* lib/areadlink.h: ...this.
* modules/mreadlink-with-size: Rename this to...
* modules/areadlink-with-size: ...this.
* lib/canonicalize.c: Reflect the renaming.
* modules/canonicalize: Likewise.
Index: NEWS
===================================================================
RCS file: /cvsroot/gnulib/gnulib/NEWS,v
retrieving revision 1.30
diff -u -p -r1.30 NEWS
--- NEWS 22 Aug 2007 12:54:22 -0000 1.30
+++ NEWS 28 Aug 2007 09:12:58 -0000
@@ -6,6 +6,11 @@ User visible incompatible changes
Date Modules Changes
+2007-08-28 areadlink-with-size
+ Renamed from mreadlink-with-size.
+ Function renamed: mreadlink_with_size ->
+ areadlink_with_size.
+
2007-08-22 getdelim, getline
The include file is changed from "getdelim.h"
and "getline.h" to the POSIX 200x <stdio.h>.
Index: lib/mreadlink-with-size.c
===================================================================
RCS file: lib/mreadlink-with-size.c
diff -N lib/mreadlink-with-size.c
--- lib/mreadlink-with-size.c 18 Jun 2007 12:21:17 -0000 1.1
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,110 +0,0 @@
-/* readlink wrapper to return the link name in malloc'd storage.
- Unlike xreadlink and xreadlink_with_size, don't ever call exit.
-
- Copyright (C) 2001, 2003-2007 Free Software Foundation, Inc.
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2, or (at your option)
- any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; see the file COPYING.
- If not, write to the Free Software Foundation,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
-
-/* Written by Jim Meyering <[EMAIL PROTECTED]> */
-
-#include <config.h>
-
-#include "mreadlink.h"
-
-#include <stdio.h>
-#include <errno.h>
-#include <limits.h>
-#include <sys/types.h>
-#include <stdlib.h>
-#include <unistd.h>
-
-#ifndef SIZE_MAX
-# define SIZE_MAX ((size_t) -1)
-#endif
-#ifndef SSIZE_MAX
-# define SSIZE_MAX ((ssize_t) (SIZE_MAX / 2))
-#endif
-
-/* SYMLINK_MAX is used only for an initial memory-allocation sanity
- check, so it's OK to guess too small on hosts where there is no
- arbitrary limit to symbolic link length. */
-#ifndef SYMLINK_MAX
-# define SYMLINK_MAX 1024
-#endif
-
-#define MAXSIZE (SIZE_MAX < SSIZE_MAX ? SIZE_MAX : SSIZE_MAX)
-
-/* Call readlink to get the symbolic link value of FILE.
- SIZE is a hint as to how long the link is expected to be;
- typically it is taken from st_size. It need not be correct.
- Return a pointer to that NUL-terminated string in malloc'd storage.
- If readlink fails, malloc fails, or if the link value is longer
- than SSIZE_MAX, return NULL (caller may use errno to diagnose). */
-
-char *
-mreadlink_with_size (char const *file, size_t size)
-{
- /* Some buggy file systems report garbage in st_size. Defend
- against them by ignoring outlandish st_size values in the initial
- memory allocation. */
- size_t symlink_max = SYMLINK_MAX;
- size_t INITIAL_LIMIT_BOUND = 8 * 1024;
- size_t initial_limit = (symlink_max < INITIAL_LIMIT_BOUND
- ? symlink_max + 1
- : INITIAL_LIMIT_BOUND);
-
- /* The initial buffer size for the link value. */
- size_t buf_size = size < initial_limit ? size + 1 : initial_limit;
-
- while (1)
- {
- ssize_t r;
- size_t link_length;
- char *buffer = malloc (buf_size);
-
- if (buffer == NULL)
- return NULL;
- r = readlink (file, buffer, buf_size);
- link_length = r;
-
- /* On AIX 5L v5.3 and HP-UX 11i v2 04/09, readlink returns -1
- with errno == ERANGE if the buffer is too small. */
- if (r < 0 && errno != ERANGE)
- {
- int saved_errno = errno;
- free (buffer);
- errno = saved_errno;
- return NULL;
- }
-
- if (link_length < buf_size)
- {
- buffer[link_length] = 0;
- return buffer;
- }
-
- free (buffer);
- if (buf_size <= MAXSIZE / 2)
- buf_size *= 2;
- else if (buf_size < MAXSIZE)
- buf_size = MAXSIZE;
- else
- {
- errno = ENOMEM;
- return NULL;
- }
- }
-}
Index: lib/areadlink-with-size.c
===================================================================
RCS file: lib/areadlink-with-size.c
diff -N lib/areadlink-with-size.c
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ lib/areadlink-with-size.c 28 Aug 2007 09:12:58 -0000
@@ -0,0 +1,110 @@
+/* readlink wrapper to return the link name in malloc'd storage.
+ Unlike xreadlink and xreadlink_with_size, don't ever call exit.
+
+ Copyright (C) 2001, 2003-2007 Free Software Foundation, Inc.
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2, or (at your option)
+ any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; see the file COPYING.
+ If not, write to the Free Software Foundation,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
+
+/* Written by Jim Meyering <[EMAIL PROTECTED]> */
+
+#include <config.h>
+
+#include "areadlink.h"
+
+#include <stdio.h>
+#include <errno.h>
+#include <limits.h>
+#include <sys/types.h>
+#include <stdlib.h>
+#include <unistd.h>
+
+#ifndef SIZE_MAX
+# define SIZE_MAX ((size_t) -1)
+#endif
+#ifndef SSIZE_MAX
+# define SSIZE_MAX ((ssize_t) (SIZE_MAX / 2))
+#endif
+
+/* SYMLINK_MAX is used only for an initial memory-allocation sanity
+ check, so it's OK to guess too small on hosts where there is no
+ arbitrary limit to symbolic link length. */
+#ifndef SYMLINK_MAX
+# define SYMLINK_MAX 1024
+#endif
+
+#define MAXSIZE (SIZE_MAX < SSIZE_MAX ? SIZE_MAX : SSIZE_MAX)
+
+/* Call readlink to get the symbolic link value of FILE.
+ SIZE is a hint as to how long the link is expected to be;
+ typically it is taken from st_size. It need not be correct.
+ Return a pointer to that NUL-terminated string in malloc'd storage.
+ If readlink fails, malloc fails, or if the link value is longer
+ than SSIZE_MAX, return NULL (caller may use errno to diagnose). */
+
+char *
+areadlink_with_size (char const *file, size_t size)
+{
+ /* Some buggy file systems report garbage in st_size. Defend
+ against them by ignoring outlandish st_size values in the initial
+ memory allocation. */
+ size_t symlink_max = SYMLINK_MAX;
+ size_t INITIAL_LIMIT_BOUND = 8 * 1024;
+ size_t initial_limit = (symlink_max < INITIAL_LIMIT_BOUND
+ ? symlink_max + 1
+ : INITIAL_LIMIT_BOUND);
+
+ /* The initial buffer size for the link value. */
+ size_t buf_size = size < initial_limit ? size + 1 : initial_limit;
+
+ while (1)
+ {
+ ssize_t r;
+ size_t link_length;
+ char *buffer = malloc (buf_size);
+
+ if (buffer == NULL)
+ return NULL;
+ r = readlink (file, buffer, buf_size);
+ link_length = r;
+
+ /* On AIX 5L v5.3 and HP-UX 11i v2 04/09, readlink returns -1
+ with errno == ERANGE if the buffer is too small. */
+ if (r < 0 && errno != ERANGE)
+ {
+ int saved_errno = errno;
+ free (buffer);
+ errno = saved_errno;
+ return NULL;
+ }
+
+ if (link_length < buf_size)
+ {
+ buffer[link_length] = 0;
+ return buffer;
+ }
+
+ free (buffer);
+ if (buf_size <= MAXSIZE / 2)
+ buf_size *= 2;
+ else if (buf_size < MAXSIZE)
+ buf_size = MAXSIZE;
+ else
+ {
+ errno = ENOMEM;
+ return NULL;
+ }
+ }
+}
Index: lib/mreadlink.h
===================================================================
RCS file: lib/mreadlink.h
diff -N lib/mreadlink.h
--- lib/mreadlink.h 18 Jun 2007 12:21:17 -0000 1.1
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,24 +0,0 @@
-/* Read symbolic links without size limitation.
-
- Copyright (C) 2001, 2003, 2004, 2007 Free Software Foundation, Inc.
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2, or (at your option)
- any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; see the file COPYING.
- If not, write to the Free Software Foundation,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
-
-/* Written by Jim Meyering <[EMAIL PROTECTED]> */
-
-#include <stddef.h>
-
-extern char *mreadlink_with_size (char const *filename, size_t size_hint);
Index: lib/areadlink.h
===================================================================
RCS file: lib/areadlink.h
diff -N lib/areadlink.h
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ lib/areadlink.h 28 Aug 2007 09:12:58 -0000
@@ -0,0 +1,24 @@
+/* Read symbolic links without size limitation.
+
+ Copyright (C) 2001, 2003, 2004, 2007 Free Software Foundation, Inc.
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2, or (at your option)
+ any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; see the file COPYING.
+ If not, write to the Free Software Foundation,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
+
+/* Written by Jim Meyering <[EMAIL PROTECTED]> */
+
+#include <stddef.h>
+
+extern char *areadlink_with_size (char const *filename, size_t size_hint);
Index: lib/canonicalize.c
===================================================================
RCS file: /cvsroot/gnulib/gnulib/lib/canonicalize.c,v
retrieving revision 1.11
diff -u -p -r1.11 canonicalize.c
--- lib/canonicalize.c 19 Jun 2007 06:13:41 -0000 1.11
+++ lib/canonicalize.c 28 Aug 2007 09:12:58 -0000
@@ -47,7 +47,7 @@
#endif
#include "pathmax.h"
-#include "mreadlink.h"
+#include "areadlink.h"
#if !HAVE_CANONICALIZE_FILE_NAME
/* Return the canonical absolute name of file NAME. A canonical name
@@ -246,7 +246,7 @@ canonicalize_filename_mode (const char *
goto error;
}
- buf = mreadlink_with_size (rname, st.st_size);
+ buf = areadlink_with_size (rname, st.st_size);
if (!buf)
{
if (can_mode == CAN_MISSING && errno != ENOMEM)
Index: modules/mreadlink-with-size
===================================================================
RCS file: modules/mreadlink-with-size
diff -N modules/mreadlink-with-size
--- modules/mreadlink-with-size 18 Jun 2007 12:21:17 -0000 1.1
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,25 +0,0 @@
-Description:
-Return the contents of a symbolic link, without size limitations.
-
-Files:
-lib/mreadlink.h
-lib/mreadlink-with-size.c
-
-Depends-on:
-readlink
-ssize_t
-unistd
-
-configure.ac:
-
-Makefile.am:
-lib_SOURCES += mreadlink-with-size.c
-
-Include:
-"mreadlink.h"
-
-License:
-GPL
-
-Maintainer:
-Jim Meyering
Index: modules/areadlink-with-size
===================================================================
RCS file: modules/areadlink-with-size
diff -N modules/areadlink-with-size
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ modules/areadlink-with-size 28 Aug 2007 09:12:58 -0000
@@ -0,0 +1,25 @@
+Description:
+Return the contents of a symbolic link, without size limitations.
+
+Files:
+lib/areadlink.h
+lib/areadlink-with-size.c
+
+Depends-on:
+readlink
+ssize_t
+unistd
+
+configure.ac:
+
+Makefile.am:
+lib_SOURCES += areadlink-with-size.c
+
+Include:
+"areadlink.h"
+
+License:
+GPL
+
+Maintainer:
+Jim Meyering
Index: modules/canonicalize
===================================================================
RCS file: /cvsroot/gnulib/gnulib/modules/canonicalize,v
retrieving revision 1.15
diff -u -p -r1.15 canonicalize
--- modules/canonicalize 18 Jun 2007 12:21:17 -0000 1.15
+++ modules/canonicalize 28 Aug 2007 09:12:58 -0000
@@ -13,7 +13,7 @@ filenamecat
sys_stat
xalloc
xgetcwd
-mreadlink-with-size
+areadlink-with-size
configure.ac:
AC_FUNC_CANONICALIZE_FILE_NAME
