Tk Library Source Code

View Ticket
Login
Ticket UUID: 567428
Title: problem with tmml documentation
Type: Bug Version: None
Submitter: lvirden Created on: 2002-06-11 14:52:51
Subsystem: None Assigned To: andreas_kupries
Priority: 5 Medium Severity:
Status: Closed Last Modified: 2002-06-18 03:34:07
Resolution: Fixed Closed By: andreas_kupries
    Closed on: 2002-06-17 20:34:07
Description:
The following modules have a problem with the way their
tmml documentation generates nroff:

counter/counter.man
fileutil/fileutil.man
ftp/ftp.man
ftpd/ftpd.man
html/html.man
irc/irc.man
javascript/javascript.man
log/log.man
math/combinatorics.man
math/math.man
mime/mime.man
mime/smtp.man
ncgi/ncgi.man
nntp/nntp.man
pop3/pop3.man
profiler/profiler.man
report/report.man
smtpd/smtpd.man
stooop/stooop.man
textutil/expander.man

The nroff that gets generated starts out with:

'\" -*- tcl -*- doctools manpage

But that causes Sun's nroff to fail to format the man page.
The error that is caused says:

$ man -s n counter
Reformatting page.  Wait...unknown preprocessor specifier -
User Comments: andreas_kupries added on 2002-06-18 03:34:07:
Logged In: YES 
user_id=75003

Accepted. Committed to head.

andreas_kupries added on 2002-06-12 00:08:10:
Logged In: YES 
user_id=75003

From the chat

akuJust looked at the comment problem and patch. 
what is the correct formatting of an nroff comment ?

lvirdenThe first line of a man page consists of either a 
nroff directory, or a specially formatted comment line that 
indicates that man should invoke additional programs for 
formatting the text

lvirden(at least on Solaris)

akuSo the first line should not have a "normal" 
comment, right ?

akuWe can enforce that in the mpexpand processor.

lvirden added on 2002-06-11 22:45:06:

File Added - 24883: pat.tcllib.docs

Logged In: YES 
user_id=15949

second try to attaching a patch file.

lvirden added on 2002-06-11 22:44:20:
Logged In: YES 
user_id=15949

I am attaching a patch to attempt a fix for this problem,
along with fixing a series of misspelled words, etc.

Attachments: