Menu

#115 move tcllib doc generation to build step

open
5
2003-05-09
2003-05-05
No

Currently the tcllib generated Makefile generates the
nroff documentation each time one does a make install.

This means that if one has to install the library on
1000 machines, the doc has to be generated a 1000 times.

A change to make use of the Makefile, the target could
be set up to only build the pieces which are out of
date, and to do so once, at build time, saving computer
resources and user time.

Discussion

  • Larry W. Virden

    Larry W. Virden - 2003-05-05
    • priority: 5 --> 1
     
  • Larry W. Virden

    Larry W. Virden - 2003-05-05

    Logged In: YES
    user_id=15949

    I know that this is not considered an important issue to
    others, so I bumped down the priority very low. Perhaps I
    will get time sometime to do something with this. I at
    least wanted to record the issue so that if others find a
    need for this type functionality, they can add comments on
    other issues relating to this.

     
  • Pat Thoyts

    Pat Thoyts - 2003-05-09

    Logged In: YES
    user_id=202636

    The new sak.tcl command now does this. When doing
    tclsh sak.tcl html
    for instance, it generates new html in the doc/html subdir
    only for modified manual pages.

    I don't know if this completely fixes this request but it's
    probably close.

     
  • Andreas Kupries

    Andreas Kupries - 2003-05-09
    • priority: 1 --> 5
     
  • Andreas Kupries

    Andreas Kupries - 2003-05-09

    Logged In: YES
    user_id=75003

    This is the first step, of three. The second is to extend
    the "gendist" subcommand to generate documentation and
    pace it into the distribution. The third and last step is to
    extend the installer to recognize stored pre-generated docs in
    an archive and use it instead of performing the generation
    itself.

    All of the steps are possible. especially given that we are now
    in tcl, and that installer and sak can share code.