X-Recipient: archive-cygwin AT delorie DOT com
X-SWARE-Spam-Status: No, hits=-1.2 required=5.0	tests=AWL,BAYES_00
X-Spam-Check-By: sourceware.org
Date: Thu, 17 May 2012 17:25:36 +0200
From: Jens Schweikhardt <schweikh AT schweikhardt DOT net>
To: cygwin AT cygwin DOT com
Subject: Re: Swallowed words in most section 3 man pages' SEE ALSO section
Message-ID: <20120517152536.GA3360@schweikhardt.net>
References: <20120503210731 DOT GA3905 AT schweikhardt DOT net>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20120503210731.GA3905@schweikhardt.net>
User-Agent: Mutt/1.5.21 (2010-09-15)
X-IsSubscribed: yes
Mailing-List: contact cygwin-help AT cygwin DOT com; run by ezmlm
Precedence: bulk
List-Id: <cygwin.cygwin.com>
List-Unsubscribe: <mailto:cygwin-unsubscribe-archive-cygwin=delorie DOT com AT cygwin DOT com>
List-Subscribe: <mailto:cygwin-subscribe AT cygwin DOT com>
List-Archive: <http://sourceware.org/ml/cygwin/>
List-Post: <mailto:cygwin AT cygwin DOT com>
List-Help: <mailto:cygwin-help AT cygwin DOT com>, <http://sourceware.org/ml/#faqs>
Sender: cygwin-owner AT cygwin DOT com
Mail-Followup-To: cygwin AT cygwin DOT com
Delivered-To: mailing list cygwin AT cygwin DOT com

I've tracked it a bit further:

On Thu, May 03, 2012 at 11:07:31PM +0200, Jens Schweikhardt wrote:
# hello, world\n
# 
# it appears that quite a number of functions in section 3 of the manual
# have the following SEE ALSO section (# added where a word is missing).
# 
# $ man 3 strstr
# [...]
# SEE ALSO
# 
#    strstr is part of the # library.  The full documentation for # is
#    maintained as a Texinfo manual.  If info and # are properly installed
#    at your site, the command info will give you access to the complete manual.
# 
# 
# This is due to missing arguments in /usr/share/man/man3/*.3.gz for
# the bold face macro .B:
# 
# SH "SEE ALSO"
# .B strstr
# is part of the
# .B
# library.
# The full documentation for
# .B
# is maintained as a Texinfo manual.  If
# .B info
# and
# .B
# are properly installed at your site, the command
# .IP
# .B info
# .PP
# will give you access to the complete manual.
# 
# 
# For a list of man pages where this is the case (more than 400), just zgrep
# for '^\.B $':
# /usr/share/man/man3$ zgrep '^\.B $' *.gz|sort -u|wc
#      410     413    6752

This is a bug in the "cygwin-doc" package, in the newlibinfo2man.pl
perl script.

157 sub print_footer
158 {
159     $out_handle = $_[0];
160     print { $out_handle } ".SH \"SEE ALSO\"\n";
161         if ((!grep /\Q$node/, @summary_nodes) && ($node ne "Library Index"))
162     {
163         print { $out_handle } ".B $node\n";
164         print { $out_handle } "is part of the\n";
165         print { $out_handle } ".B $title\n";
166         print { $out_handle } "library.\n";
167     }
168     print { $out_handle } "The full documentation for\n";
169     print { $out_handle } ".B $title\n";
170     print { $out_handle } "is maintained as a Texinfo manual.  If \n";
171     print { $out_handle } ".B info\n";
172     print { $out_handle } "and\n";
173     print { $out_handle } ".B $title\n";
174     print { $out_handle } "are properly installed at your site, ";
175     print { $out_handle } "the command\n";
176     print { $out_handle } ".IP\n";
177     print { $out_handle } ".B info $title\n";
178     print { $out_handle } ".PP\n";
179     print { $out_handle } "will give you access to the complete manual.\n";
180     print "finished $node of $title\n" if ($debug);
181     close ($out_handle);
182 }

$title is undefined because it is declared "my" in the loop iterating
over @ARGV calling print_footer. Can someone with more cygwin|src|build-fu
fix this? Thanks!

Regards,

	Jens
-- 
Jens Schweikhardt http://www.schweikhardt.net/
SIGSIG -- signature too long (core dumped)

--
Problem reports:       http://cygwin.com/problems.html
FAQ:                   http://cygwin.com/faq/
Documentation:         http://cygwin.com/docs.html
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple