[Bug manual/15748] New: Confusing or wrong cross-reference

[Bug manual/15748] New: Confusing or wrong cross-reference

[rrt at sc3d dot org]

http://sourceware.org/bugzilla/show_bug.cgi?id=15748

            Bug ID: 15748
           Summary: Confusing or wrong cross-reference
           Product: glibc
           Version: unspecified
            Status: NEW
          Severity: normal
          Priority: P2
         Component: manual
          Assignee: unassigned at sourceware dot org
          Reporter: rrt at sc3d dot org
                CC: mtk.manpages at gmail dot com, roland at gnu dot org

At the end of the section "Parsing of Floats" is the paragraph:

   The GNU C Library also provides `_l' versions of these functions,
which take an additional argument, the locale to use in conversion.
*Note Parsing of Integers::.

The placing of the cross-reference implies that the `_l' versions of these
functions are documented in the referred-to section, but they are not (indeed,
no such functions are documented there). I can guess three reasons:

1. The cross-reference should be to another section. In that case, it should be
fixed.

2. Some documentation is missing in the section "Parsing of Integers". In that
case, it should be written.

3. The cross-reference does not refer to the immediately-preceding text, but is
a "see also" for the entire section, i.e., having read about parsing floats,
you may want to read about parsing integers. In that case, put the
cross-reference in a new paragraph, starting "See also", or whatever the
standard notation for standalone cross-references is in the glibc manual.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/15748] Confusing or wrong cross-reference

[allan at archlinux dot org]

http://sourceware.org/bugzilla/show_bug.cgi?id=15748

Allan McRae <allan at archlinux dot org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |allan at archlinux dot org
           Assignee|unassigned at sourceware dot org   |allan at archlinux dot org

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/15748] Confusing or wrong cross-reference

[allan at archlinux dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=15748

Allan McRae <allan at archlinux dot org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|---                         |FIXED

--- Comment #1 from Allan McRae <allan at archlinux dot org> ---
commit aa04af0078dafb6af40b1ee0ede140eedbf67c4f
Author: Allan McRae <allan@archlinux.org>
Date:   Tue Sep 10 14:12:10 2013 +1000

    Clarify documentation cross-reference

    The end of the "Parsing of Floats" subsection currently reads:

       The GNU C Library also provides '_l' versions of these functions,
    which take an additional argument, the locale to use in conversion.
    *Note Parsing of Integers::.

    Split the final note as it is unrelated to the above comment and
    reference it with "See also" instead.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug manual/15748] Confusing or wrong cross-reference

[fweimer at redhat dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=15748

Florian Weimer <fweimer at redhat dot com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
              Flags|                            |security-

-- 
You are receiving this mail because:
You are on the CC list for the bug.