Tcl Source Code

View Ticket
Login
Ticket UUID: 3612422
Title: tclvars(n) man page went missing
Type: Bug Created on: 2013-05-01 16:40:10
Submitter: bencollver Assigned to: dkf
Subsystem: 53. Configuration and Build Tools Severity: Minor
Priority: 6 Last modified: 2013-09-29 13:00:11
Status: Pending Closed by: nobody
Resolution: Fixed Closed on:
Version: current: 8.6.0
Description:
The TCL build scripts install the man pages automatically based on the .SH NAME section.  This was changed before 8.6.0 b2.  Before, the tclvars(n) man page was installed.  Now it isn't..  The fix would be to add tclvars back to the list.

From http://core.tcl.tk/tcl/fdiff?v1=8fae400bbb08d9b1&v2=f14b4d52b6e3fb03&patch

 '\" Note:  do not modify the .SH NAME line immediately below!
 .SH NAME
-tclvars \- Variables used by Tcl
+argc, argv, argv0, auto_path, env, errorCode, errorInfo, tcl_interactive, tcl_library, tcl_nonwordchars, tcl_patchLevel, tcl_pkgPath, tcl_platform, tcl_precision, tcl_rcFileName, tcl_traceCompile, tcl_traceEval, tcl_wordchars, tcl_version \- Variables used by Tcl
 .BE
User Comments:
dkf added on 2013-05-03 17:30:20:
That change is "as designed"; that you have to go to 'tclvars' for information about specific variables is magical knowledge, and we want to limit the amount of that in the documentation. The page ought to be there with the other names listed.

Or do the install scripts (for which platform, which distribution?) fail for some reason?

bencollver added on 2013-05-03 21:02:00:
I would not have reported this if I had known that it was by design.  This is for the unix platform.  This behavior does not seem specific to any particular distribution.  If I read unix/installManPage correctly, it goes strictly by .SH NAME.  It installs the man page as the first name, and then links the other names listed.  In this case, it installs the man page as argc.n and links the rest of the names in the list, which does not include tclvars.

dgp added on 2013-05-20 21:46:34:
dkf, in that case, the "SEE ALSO" sections of other
man pages ought not continue to reference "tclvars(n)",
right?

dkf added on 2013-08-21 09:47:32:

Correct; they should not, or at least not unless they are referring to the collection of variables in aggregate.


dkf added on 2013-08-21 10:30:20:

Fixed the references in the trunk, but the .TH line still mentions tclvars; I'm not sure what to do about that (if anything!)