Bug 41972

Summary: A statement in ftpusers.5 can't be output correctly with the current groff application
Product: Documentation Reporter: yt-kage <yt-kage>
Component: Books & ArticlesAssignee: Giorgos Keramidas <keramida>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description yt-kage 2002-08-24 15:20:03 UTC 
In a manual file ftpusers.5, there is a statement which can't be displayed properly with the groff application currently installed in FreeBSD 4-STABLE, groff 1.17.2:
(In line 160-166)
.Pp
The syntax is similar to
.Nm "" ,
except that the  
.Sy class
argument is ignored.

When you process these lines with the groff 1.17.2, you will find the .Nm macro line processed wrong. The output is:
"The syntax is similar to , except that the class argument is ignored. "
It is similar to what?

How-To-Repeat: groff -Tascii -mdoc ftpusers.5
Comment 1 Giorgos Keramidas freebsd_committer freebsd_triage 2002-08-25 01:31:05 UTC 
State Changed
From-To: open->analyzed

I've emailed lukem, and will take care of the PR when he replies.
Comment 2 Giorgos Keramidas freebsd_committer freebsd_triage 2002-08-25 01:31:05 UTC 
Responsible Changed
From-To: freebsd-doc->keramida
Comment 3 Giorgos Keramidas freebsd_committer freebsd_triage 2002-08-25 01:34:27 UTC 
On 2002-08-24 07:19 +0000, Yoshiteru Kageyama wrote:
> >Synopsis:       A statement in ftpusers.5 can't be output correctly with the current groff application

ftpusers.5 is installed from the ftpd sources.  The ftpd sources are
part of contrib/lukemftpd which is contributed software.  I've emailed
the author of the FTP server software and asked him to change this in
the official source.  This way, when a newer version is cleanly
imported to FreeBSD we'll get this fix too.

Thanks for submitting this :)

- Giorgos
Comment 4 Giorgos Keramidas freebsd_committer freebsd_triage 2002-08-26 03:48:42 UTC 
> From: Giorgos Keramidas <keramida@FreeBSD.org>
> Date: Sun, 25 Aug 2002 03:34:27 +0300
>
>  ftpusers.5 is installed from the ftpd sources.  The ftpd sources are
>  part of contrib/lukemftpd which is contributed software.  I've emailed
>  the author of the FTP server software and asked him to change this in
>  the official source.  This way, when a newer version is cleanly
>  imported to FreeBSD we'll get this fix too.

Apparently, NetBSD's groff is version 1.16 and the canonical way to
use .Nm is (according to Luke Mewburn, the author of lukemftpd):

	.Nm "" ,

in this case.  FreeBSD's version of groff is 1.17 and the behavior of
the .Nm macro has changed.  This is why the ftpusers.5 manpage seems
to have a "wrong" behavior.

- Giorgos
Comment 5 yt-kage 2002-08-27 17:20:51 UTC 
Hi, Giorgos san,

Thank you for dealing with my PR.

At Mon, 26 Aug 2002 05:48:42 +0300,
Giorgos Keramidas wrote:

> Apparently, NetBSD's groff is version 1.16 and the canonical way to
> use .Nm is (according to Luke Mewburn, the author of lukemftpd):
> 
> 	.Nm "" ,
> 
> in this case.  FreeBSD's version of groff is 1.17 and the behavior of
> the .Nm macro has changed.  This is why the ftpusers.5 manpage seems
> to have a "wrong" behavior.

O.K. I understand what the root cause of this problem is.
Anyway, what are we going to do then to improve this behavior?
Is it better for us to modify the portion of .Nm macro only for
FreeBSD, or to keep it as it is?

Regards,
Kageyama
Comment 6 Giorgos Keramidas freebsd_committer freebsd_triage 2002-08-27 21:26:14 UTC 
On 2002-08-28 01:20 +0000, Yoshiteru Kageyama wrote:
> At Mon, 26 Aug 2002 05:48:42 +0300,
> Giorgos Keramidas wrote:
> > in this case.  FreeBSD's version of groff is 1.17 and the behavior
> > of the .Nm macro has changed.  This is why the ftpusers.5 manpage
> > seems to have a "wrong" behavior.
>
> O.K. I understand what the root cause of this problem is.

David O' Brien has imported lukemftpd to our CVS repository.

David, is it okay to commit changes to this file?  It's still in the
vendor branch, so I wouldn't want to cause trouble for future imports
without asking first.

-- 
FreeBSD: The Power to Serve -- http://www.FreeBSD.org
Comment 7 David E. O'Brien freebsd_committer freebsd_triage 2002-08-28 06:13:28 UTC 
I would like to see RU comment about the groff 1.6 vs. 1.7 issue first.

On Tue, Aug 27, 2002 at 11:26:14PM +0300, Giorgos Keramidas wrote:
> David, is it okay to commit changes to this file?  It's still in the
> vendor branch, so I wouldn't want to cause trouble for future imports
> without asking first.
Comment 8 David E. O'Brien freebsd_committer freebsd_triage 2002-08-28 06:15:35 UTC 
"serious" severity, and "medium" priority for a minor one-line doc bug.
Give me a break!!!  severity and priority set to appropriate values.
Comment 9 ru freebsd_committer freebsd_triage 2002-09-16 11:20:51 UTC 
On Tue, Aug 27, 2002 at 10:13:28PM -0700, David O'Brien wrote:
> I would like to see RU comment about the groff 1.6 vs. 1.7 issue first.
> 
> On Tue, Aug 27, 2002 at 11:26:14PM +0300, Giorgos Keramidas wrote:
> > David, is it okay to commit changes to this file?  It's still in the
> > vendor branch, so I wouldn't want to cause trouble for future imports
> > without asking first.
> 

Yep, these should be taken out of the vendor branch.


Cheers,
-- 
Ruslan Ermilov		Sysadmin and DBA,
ru@sunbay.com		Sunbay Software AG,
ru@FreeBSD.org		FreeBSD committer,
+380.652.512.251	Simferopol, Ukraine

http://www.FreeBSD.org	The Power To Serve
http://www.oracle.com	Enabling The Information Age
Comment 10 Giorgos Keramidas freebsd_committer freebsd_triage 2002-12-14 23:46:14 UTC 
State Changed
From-To: analyzed->closed

The change has been committed to 5.0-CURRENT. 
I also updated ftpd.conf.5 which has similar problems with .Nm usage.