Tcl Library Source Code

Check-in [7f953a0106]
Login
Bounty program for improvements to Tcl and certain Tcl packages.
Tcl 2019 Conference, Houston/TX, US, Nov 4-8
Send your abstracts to [email protected]
or submit via the online form by Sep 9.

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Squash very old (read: outdated) dev- and release guides.
Timelines: family | ancestors | descendants | both | doc-overhaul
Files: files | file ages | folders
SHA3-256: 7f953a01062525c90e34c1e60a4169b3b6f716e1640974067f89a024279da150
User & Date: aku 2019-03-06 08:16:03
Context
2019-03-07
06:41
Removed outdated `devdoc/cvs.branches.fig`. Removed `devdoc/README.releasemgr`. Replaced by `devdoc/tcllib_releasemgr.man`. TODO: Filling in the explanation of various tasks. Added `devdoc/tcllib_devguide.man`. Partially done. check-in: 205ddce17f user: aku tags: doc-overhaul
2019-03-06
08:16
Squash very old (read: outdated) dev- and release guides. check-in: 7f953a0106 user: aku tags: doc-overhaul
08:13
Removed `devdoc/installation.txt`. Was a duplicate of `devdoc/dirlayout_install.txt`, thus superfluous. Reworked the installation instructions. Folded unix and windows into a single section based on the older `devdoc/INSTALL.txt`. This thus became superfluous, and was removed. check-in: 2e0a176af7 user: aku tags: doc-overhaul
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Deleted devdoc/devguide.html.

     1         -<!- Guide for Tcllib developers -->
     2         -
     3         -<h1>Guide for Tcllib developers.
     4         -</h1>
     5         -<hr>
     6         -
     7         -<h2>CVS Repository
     8         -</h2>
     9         -<table><tr><td valign=top>
    10         -      <!-- The local source of this image is
    11         -		tcllib/devel/cvs.branches.*
    12         -	-->
    13         -      <img src="http://sourceforge.net/dbimage.php?id=2221">
    14         -</td><td valign=top><p>
    15         -
    16         -The CVS repository for Tcllib contains two main branches, the HEAD for
    17         -development, and RELEASES as the staging area for official
    18         -releases. At RELEASES the minor branches containing the various
    19         -official releases are anchored at.
    20         -</p></td></tr></table>
    21         -
    22         -<p>All the branches are of interest to the developers for
    23         -      Tcllib. Ongoing development happens in HEAD, which can be
    24         -      unstable or may not work at all. Whenever a developer considers
    25         -      a piece of code, or module, he is responsible for as
    26         -      sufficiently stable she has to perform an internal release which
    27         -      merges this part from HEAD into RELEASES. Tools to help with
    28         -      this will be provided.
    29         -</p>
    30         -
    31         -<p>The branches for the official releases of tcllib are of interest to
    32         -      a developer because it is expected that fixes for important bugs
    33         -      not only go into the HEAD branch but also into the release
    34         -      branches for the release they were found in and all releases
    35         -      following that one. This is to allow the release manager to
    36         -      create patch releases of existing releases distributing important
    37         -      bugfixes as well.
    38         -</p>
    39         -
    40         -<p>Version numbers for modules are handled as described below. This
    41         -      way of handling them was chosen so that the modules in the
    42         -      development branch always uses version numbers different from
    43         -      the version numbers in the official releases made so far.
    44         -</p>
    45         -<ul>
    46         -<li>Whenever an internal release of a module FOO is done, the
    47         -	developer performing this internal release has to increment
    48         -	the version number of the module <b>after</b> the release was
    49         -	executed.
    50         -</ul>

Deleted devdoc/releaseguide.html.

     1         -<!- Guide to the creation of source releases for Tcllib -->
     2         -
     3         -<h1>Guide to the creation of source releases for Tcllib
     4         -</h1>
     5         -<hr>
     6         -
     7         -<h2>Recap
     8         -</h2>
     9         -<table><tr><td valign=top>
    10         -      <!-- The local source of this image is
    11         -		tcllib/devel/cvs.branches.*
    12         -	-->
    13         -      <img src="http://sourceforge.net/dbimage.php?id=2221">
    14         -</td><td valign=top><p>
    15         -The CVS repository for Tcllib contains two main branches,
    16         -      the HEAD for development, and RELEASES as the staging area for
    17         -      official releases.
    18         -</p></td></tr></table>
    19         -
    20         -<h2>Dependencies
    21         -</h2>
    22         -
    23         -<h2>Creation of a new official release
    24         -</h2>
    25         -
    26         -<p>To create a new official release of Tcllib the release manager has
    27         -      to perform the steps described below:
    28         -</p>
    29         -
    30         -
    31         -<ol>
    32         -<li> Retrieve the sources at the current head
    33         -	from the CVS repository, using a command like
    34         -<pre>
    35         -	  CVSROOT=:pserver:[email protected]:/cvsroot/tcllib
    36         -	  cvs -d${CVSROOT} co tcllib
    37         -</pre>
    38         -	Vary this command according to taste as long as the overall
    39         -	meaning is not changed. Compression options and the like.
    40         -
    41         -<li> Tag these sources with a new branch tag for the new release of
    42         -	  tcllib, like
    43         -<pre>
    44         -	  cvs -d${CVSROOT} rtag tcllib
    45         -</pre>
    46         -
    47         -<li> Commit the changes, then update the working directory.
    48         -
    49         -<li> Use a tclsh to run the <b>sak</b> tool with the argument <i>gendist</i>, like
    50         -<pre>
    51         -    tclsh /path/to/tcllib/sak.tcl gendist
    52         -</pre>
    53         -
    54         -<li> This results in the creation of a <i>tcllib-VERSION</i> directory
    55         -in the current working directory, and of two archives, <i>.zip</i>,
    56         -and <i>.tar.gz</i>. A starkit will be created if <b>sdx</b> is present
    57         -in the PATH. If additionally a file named <b>tclkit</b> is present in
    58         -the current working directory a starpack will be created too, using
    59         -this tclkit as the runtime.
    60         -
    61         -
    62         -<li> Now follow the instructions in the Sourceforge site documentation
    63         -		    for uploading the archives generated by the last
    64         -		    step to
    65         -		    <b>ftp://upload.sourceforge.net/incoming</b>, and
    66         -		    follow the procedures for creating packages and
    67         -		    releases at Sourceforge.
    68         -</ol>
    69         -
    70         -<p>At last notify the relevant persons in other communities like
    71         -Debian (See list of contacts) about the new release.
    72         -</p>