#5235 tclvars(n) man page went missing

current: 8.6.0
open-invalid
5
2013-05-03
2013-05-01
Ben Collver
No

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

Discussion

  • Donal K. Fellows

    • assigned_to: nobody --> dkf
    • labels: 104246 --> 53. Configuration and Build Tools
    • status: open --> open-invalid
     
  • Donal K. Fellows

    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?

     
  • Ben Collver

    Ben Collver - 2013-05-03

    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.

     
  • Don Porter

    Don Porter - 2013-05-20

    dkf, in that case, the "SEE ALSO" sections of other
    man pages ought not continue to reference "tclvars(n)",
    right?