Debian Bug report logs - #381692
manpages-dev: get_current_dir_name is not posix

Toggle useless messages

Message #5 received at submit@bugs.debian.org (full text, mbox, reply):

From: Samuel Thibault <samuel.thibault@ens-lyon.org>

To: Debian Bug Tracking System <submit@bugs.debian.org>

Subject: manpages-dev: get_current_dir_name is not posix

Date: Sun, 6 Aug 2006 16:06:23 +0200

Package: manpages-dev
Version: 2.36-2
Severity: minor

Hi,

Along get_current_dir_name(3) are documented getcwd and getwd, which are
posix, but get_current_dir_name is _not_, and #define _GNU_SOURCE is
needed for getting it. The manpage should hence note in SYNOPSIS that
#define _GNU_SOURCE is needed for get_current_dir_name, and in
CONFORMING TO that get_current_dir_name is a GNU extension.

Regards,
Samuel

-- System Information:
Debian Release: testing/unstable
  APT prefers unstable
  APT policy: (900, 'unstable'), (500, 'testing'), (500, 'stable'), (1, 'experimental')
Architecture: i386 (i686)
Shell:  /bin/sh linked to /bin/bash
Kernel: Linux 2.6.17
Locale: LANG=fr_FR@euro, LC_CTYPE=fr_FR@euro (charmap=ISO-8859-15)

Versions of packages manpages-dev depends on:
ii  manpages                      2.36-2     Manual pages about using a GNU/Lin

manpages-dev recommends no packages.

-- no debconf information

Message #10 received at 381692@bugs.debian.org (full text, mbox, reply):

From: Michael Kerrisk <mtk-manpages@gmx.net>

To: Samuel Thibault <samuel.thibault@ens-lyon.org>, 381692@bugs.debian.org

Cc: debc <control@bugs.debian.org>

Subject: Re: Bug#381692: manpages-dev: get_current_dir_name is not posix

Date: Mon, 07 Aug 2006 14:18:26 +0200

tags 381692 fixed-upstream
thanks

Salut Samuel,

> Along get_current_dir_name(3) are documented getcwd and getwd, which are
> posix, but get_current_dir_name is _not_, and #define _GNU_SOURCE is
> needed for getting it. The manpage should hence note in SYNOPSIS that
> #define _GNU_SOURCE is needed for get_current_dir_name, and in
> CONFORMING TO that get_current_dir_name is a GNU extension.

In fact the required feature test macros are already documented
in the manual page body:

       get_current_dir_name(), which is only  prototyped  if
       _GNU_SOURCE  is  defined, will malloc(3) an array big
       enough to hold the current directory  name. ...

       getwd(), which is only prototyped if  _BSD_SOURCE  or
       _XOPEN_SOURCE_EXTENDED is defined, will not malloc(3)
       any memory.

But I agree that they would better be documented in the SYNOPSIS,
and I have changed the manual page so they are documented there:

   SYNOPSIS
       #include <unistd.h>

       char *getcwd(char *buf, size_t size);

       #define _BSD_SOURCE     /* Or: #define _XOPEN_SOURCE 500 */
       #include <unistd.h>

       char *getwd(char *buf);

       #define _GNU_SOURCE
       #include <unistd.h>

       char *get_current_dir_name(void);

I also fixed the CONFORMING TO section, which now reads:

   CONFORMING TO
       getcwd()  conforms  to  POSIX.1-2001.    getwd()   is
       present in POSIX.1-2001, but marked LEGACY.  get_cur-
       rent_dir_name() is a GNU extension.

Fixes will be in upstream 2.40.  Thanks for your report.

Cheers,

Michael

-- 
Michael Kerrisk
maintainer of Linux man pages Sections 2, 3, 4, 5, and 7

Want to help with man page maintenance?  Grab the latest tarball at
ftp://ftp.win.tue.nl/pub/linux-local/manpages/,
read the HOWTOHELP file and grep the source files for 'FIXME'.

Message #17 received at 381692-close@bugs.debian.org (full text, mbox, reply):

From: Martin Schulze <joey@infodrom.org>

To: 381692-close@bugs.debian.org

Subject: Bug#381692: fixed in manpages 2.40-1

Date: Sun, 11 Feb 2007 08:32:04 +0000

Source: manpages
Source-Version: 2.40-1

We believe that the bug you reported is fixed in the latest version of
manpages, which is due to be installed in the Debian FTP archive:

manpages-dev_2.40-1_all.deb
  to pool/main/m/manpages/manpages-dev_2.40-1_all.deb
manpages_2.40-1.diff.gz
  to pool/main/m/manpages/manpages_2.40-1.diff.gz
manpages_2.40-1.dsc
  to pool/main/m/manpages/manpages_2.40-1.dsc
manpages_2.40-1_all.deb
  to pool/main/m/manpages/manpages_2.40-1_all.deb
manpages_2.40.orig.tar.gz
  to pool/main/m/manpages/manpages_2.40.orig.tar.gz



A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 381692@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Martin Schulze <joey@infodrom.org> (supplier of updated manpages package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Format: 1.7
Date: Sun, 11 Feb 2007 08:34:14 +0100
Source: manpages
Binary: manpages manpages-dev
Architecture: source all
Version: 2.40-1
Distribution: unstable
Urgency: low
Maintainer: Martin Schulze <joey@debian.org>
Changed-By: Martin Schulze <joey@infodrom.org>
Description: 
 manpages   - Manual pages about using a GNU/Linux system
 manpages-dev - Manual pages about using GNU/Linux for development
Closes: 381692
Changes: 
 manpages (2.40-1) unstable; urgency=low
 .
   * New upstream source
     . Fix SYNOPSIS and CONFORMING TO text for getwd() and
       get_current_dir() (closes: Bug#381692)
Files: 
 abbe72615985d18a89c1eb85a26b43fa 584 doc - manpages_2.40-1.dsc
 1c446d2e4847e16e6ed8bcaf651cbbe4 1193361 doc - manpages_2.40.orig.tar.gz
 b62b658a122033f989e8bff2e2046a35 53288 doc - manpages_2.40-1.diff.gz
 7e459454166827e6ef72d813082777df 485442 doc important manpages_2.40-1_all.deb
 9ea3608fa3104fce067f4098ca945f04 1218354 doc standard manpages-dev_2.40-1_all.deb

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)

iD8DBQFFzsztW5ql+IAeqTIRAqnFAKCZKG164tHAh9M0piW1zgositEEcgCfZk94
soTR8aUZGK9BBMg/MNxfOlw=
=o8mc
-----END PGP SIGNATURE-----

Send a report that this bug log contains spam.