path: root/Master/tlpkg/doc/releng.txt

$Id$
Public domain.

Notes on putting together the pretest and yearly release --karl.
See ./packages.txt for info on regular updates, adding/removing platforms, etc.

Coordinate schedule with:
 maintainers of: engines, LaTeX, GUST font, asymptote, context, texworks
 other parts of collection: protext, ctan, mactex.
 general lists

To stop updating of certain packages before the general freeze:
 tlpkg/dev/tlnet-disabled-packages.txt

On the day of the last tlnet update,
 Set opt_frozen in 00texlive.installation.tlpsrc.
 Freeze should happen at that night's rebuild.

Check if pretest mirrors need renewing, talk to mirror admins if so:
 http://tug.org/texlive/mirmon/
 /home/httpd/html/texlive/mirmon/tlpretest-mirrors.txt


Then, the next day, start building tlpretest:

0. Reset opt_frozen to 0 in 00texlive.installation.tlpsrc.

1a. Preserve final tlnet of current release:
cd /home/ftp/texlive/tlnet
cp -ar ../tlnet /home/ftp/historic/systems/texlive/YYYY/tlnet-final

1b. Set up tlpretest:
#old: tar cf - [a-u]* | (cd ../tlpretest && tar xf -)  # do not copy README
Better to empty tlpretest, touch texlive.tlpdb; then --recreate should suffice.
Update /home/ftp/texlive/tlpretest/README.
Update pretest.html, notably including major changes this year.
diff new and old bindirs to see if there are interesting new programs:
  \ls $lb >/tmp/now
  \ls $ib >/tmp/new
  comm -3 /tmp/now /tmp/new >/tmp/cm

2. Then switch to pretest in cron.tl:
critical=--critical	 # push tlcritical
pretest=--pretest	 # update tlpretest, not tlnet (if not frozen)
net_frozen=false 	 # update tlnet|tlpretest (per $pretest)
(tlcritical will remain getting updated daily, even though it doesn't
 work with tlnet any more.  That's ok.  Or disable if you prefer.)
First build will happen below.

3. option adjustrepo 0 in tl-update-tlnet, since pretest shouldn't go
to CTAN for updates.

4a. When starting trial builds (earlier):
Build/source/{version.ac,texk/{kpathsea,ptexenc}/version.ac: no /dev
Also good to do other version/year updates as below.

4b. When starting pretest, basic updates for release year:
Master/.mkisofsrc
Master/release-texlive.txt
Master/tlpkg/TeXLive/TLConfig.pm (including MinRelease)
Master/tlpkg/bin/tl-update-tlnet
Master/tlpkg/bin/tl-update-images
Master/tlpkg/installer/texlive.png
Master/texmf-dist/web2c/texmfcnf.lua
Master/texmf-dist/web2c/texmf.cnf  # from Build/.../kpathsea
(check/update copyright years in *.pm, tlmgr*, install-tl, tlpkg/installer)

5. Ensure version numbers in sources are updated; see list below.
Then commit new binaries with tl-update-bindir.

6. After committing, run tex \\end to check that mktexfmt works.  Run
fmtutil --all to check that all formats build, no config file
problems.  Then, so things will get redone later as another check:
  rm -rf ~/.texlive`date +%Y`  # the new one

7. Check for Build-maintained updates to config files, etc.
(and might have to merge back if Master was mistakenly updated):
  diff -ru0 --exclude=man --exclude=info \
    Build/source/inst/texmf-dist Master/texmf-dist
for p in *conv hbf2gf; do cp /home/ftp/mirror/rsync.tex.ac.uk/CTAN/language/chinese/CJK/cjk-4.8.4/doc/pdf/$p.pdf $p; done

8. Now, ready to do first update of tlpretest:
  force_rebuild=true cron.tl

9. After first successful pretest build, do
recreate=--recreate  # just once! to get catalogue updates.

A. After tlnet freeze:
  Run tl-update-linked-scripts for consistency.
  In Master/tlpkg, update bundled Windows programs as needed:
    dviout texworks tlgs tlperl tlpsv
  In tlpkg/installer, update xz and wget if needed
  Update readme-html.dir/readme.en.html if needed
    run tlpkg/bin/htmltext to create readme-txt.dir/README.EN.
  Update texcollection DVD text:
    http://tug.org/texcollection/
    http://puszcza.gnu.org.ua/projects/texcollection/

A.0. Specifics for tlperl update:
  cd $pg
  find tlperl -type f | sort >/tmp/now
  tar tf newperl.tgz | \grep -v /\$ | sort >/tmp/new
  comm -13 /tmp/now /tmp/new >/tmp/c2
  comm -23 /tmp/now /tmp/new >/tmp/c1
  svn rm `cat /tmp/c1`
  svn add --parents --no-auto-props `cat /tmp/c2`
  svn status | fgrep \? # shouldn't be any
  find tlperl -name \*.dll | xargs svn propset svn:executable 1
  find . -type d -empty | xargs svn rm  # repeat until no output
  svn commit when ready ...

B. Build a test ISO image for initial TeX Collection testing:
  In cron.tl, set images_frozen=false.
  In tl-update-images, ensure V= the new YYYY and target=/.../test
  Update /home/ftp/texlive/Images/test/README.
  After successful image build, email tldistro@tug.org for info/review.
  Can disable image building again after the initial build for a while.


M. As work proceeds, update the doc:
  Update texlive-en.tex (+ .pdf, .html), tell tldoc to translate.
  Update tlbuild.texi.
  Consider updates of core man pages in Build/source/texk/web2c/man.
  Remake updmap,fmtutil man pages with help2man:
    make -C Build/source/Work/texk/texlive/tl_scripts xupdmap.1 xfmtutil.1
  Texinfo manuals from Build to Master:
    tl-update-txi  # then commit in texmf-dist/doc
  Man pages from Build to Master (after doing a build):
    tl-update-man
    # then run make in texmf/doc/man
    # and check /tmp/so.rules against man1/Makefile

N. Really test during pretest (really! don't leave it for knuth!):
  .fmt's sharable across endian-different platforms (including luatex).
  interactive mf '\drawdot (50,50); showit;'  % and from * prompt

O. Just before the final pretest (i.e., to-be-published) build:
  option adjustrepo 1 in tl-update-tlnet, else install-tl-unx won't go to ctan
  Update Master/source:
    xz wget w32tex-src texlive*source mactexdoc install-tl-unx.tar.gz 
    tlmgr version number in texmf-dist/scripts/texlive/NEWS 
  Tell developers no more commits: akira, takuji, luigi, taco.
  Put date into NEWS and ChangeLog files.

P. After final build, to do total freeze:
  In cron.tl, set *_frozen=true.
  Probably also just disable the cron entry.


When finalizing sources (any time in the new year, can be early, before
initial builds in any case):
- update version numbers, years, and copyright years in:
  top level version.ac
  dvipdfm-x:configure.ac
  dvips:    configure.ac NEWS dvips.c dvips.h afm2tfm.c dvips.texi
  kpathsea: version.ac NEWS kpsewhich.c doc/kpathsea.texi texmf.cnf
  ptexenc:  version.ac
  web2c:    NEWS doc/web2c.texi ptexdir/ptex-base.ch,ptex_version.h
  texk/*/version.ac, libs/*/version.ac, utils/*/version.ac
  then reautoconf (6min), rebuild.
  install-tl, tlmgr.pl (copyright only)
  check *.c *.h sources in above for needed copyright year updates too.
  run ~karl/bin/tlversions to see+compare engine/etc. versions
- if new kpathsea file types (kpsewhich --help), update kpathsea.texi.
- ask tldistro for patches.


Making the big release:

- unmount live install of last year's:
umount /home/ftp/texlive/Contents/live

hx=/home/ftp/historic/systems/texlive
prev=2014
this=2015
mkdir $hx/$this

cd /home/ftp/texlive/Images
cp README.html $hx/$prev/
mv *.iso* *.torrent* $hx/$prev/
mv test/texlive2*.iso* .
mv test/texlive*.tar.xz* $hx/$this/       # tar version only in historic
cp test/install-tl-unx.tar.gz $hx/$this/
update README (touch even if no real changes needed)
   and test/README (pretest over)

- mactex (from tlpretest)
hm=/home/ftp/historic/systems/mactex
mkdir $hm/$prev
cd ~ftp/tex/mactex
mv mactex*.pkg* basic* $hm/$prev
mv ~ftp/texlive/tlpretest/mactex* .
ln -s mactex-20*.pkg MacTeX.pkg 

- rest of tlnet
cd /home/ftp/texlive/tlnet
mkdir $hx/$prev/tlnet
cd /home/ftp/texlive/tlnet
diff -qr . $hx/$prev/tlnet-final # should already be there from before, so:
rm -rf [a-z]*
mv ../tlpretest/[a-z]* .
update README (touch even if no real changes needed)
   and ../tlpretest/README (pretest over)

- update on CTAN to avoid copying everything back again:
cy=/home/ftp/tex-archive/systems
fx=/home/ftp/tex
cp -a ... $cy/texlive/Images/
cp -a ... $cy/texlive/Source/
cp -a ... $cy/texlive/tlnet/
cp -a $fx/mactex/* $cy/mac/mactex/
cp -a $fx/protext/dist/* $cy/windows/protext/ # probably already done
cd /home/httpd/html/texlive

- TL web pages:
mkdir $hx/$prev/web
cp *.html !$  # remove tugstyle.css ref from bugs.html

- tug.org stuff:
change fstab 
mount /mnt/tl
cd /mnt/tl
perl install-tl # do full install to default location.
rm /usr/local/texlive-rel; ln -s texlive/$this /usr/local/texlive-rel
newsrc=!$/source
mkdir $newsrc
cp source/{install-tl,texlive,w32tex}*.tar.?z $newsrc
mount /home/ftp/texlive/Contents/live
cd && umount /mnt/tl

update historic/systems with final proTeXt, when ready.
  https://bscw.fernuni-hagen.de
  ftp://ftp.fernuni-hagen.de/pub/windows/win32/ProTeXt/
update ~www/texlive web pages (search for $prev and $prev-1):
  acquire* - general
  bugs.html - general, also case of $prevprev at bottom
  doc.html - platform list, translation list
  quickinstall.html - paths
  tlmgr-news.html - from texmf-dist/scripts/texlive/NEWS
  w32client.html - new w32client*.zip needed (siep)
check for new Texinfo manuals to link to html versions:
  ~www/texinfohtml
further web updates below.
update pdftex repository with sync-pdftex.sh.

- announcements:
Dick @ updating MacTeX.
Martin @ torrents.
CTAN @ ISO update, re-enabling tlnet mirroring.
Siep @ w32client.html, Norbert @ debian,updmap-kanji.html.

- make tag + branch:
(determine revision number from svn log, in case commits were mistakenly made)
svn copy -r 37491 -m'texlive-2015.0 tag based on r37491' \
  svn://tug.org/texlive/trunk svn://tug.org/texlive/tags/texlive-2015.0
svn copy -r 37491 -m'branch2015 branch based on r37491' \
  svn://tug.org/texlive/trunk svn://tug.org/texlive/branches/branch2015

  It's the same command, just different destinations.
  http://svnbook.red-bean.com/en/1.5/svn-book.html#svn.branchmerge

  We do both a branch and a tag so that it's possible to easily compare
  the current state of the branch with its starting point (the tag).

  To check out the branch, for critical source fixes for the sake of
  during-the-year rebuilds or for the distros, if they request it:
cd /home/texlive
rm -rf branch # when starting a new year on tug
mkdir branch; cd branch
svn co file:///home/svn/texlive/branches/branch2015/Build/source . >&out

   When bug fixes are done, i.e., at another stable point, make another tag:
#svn copy -r 30858 -m'texlive-2013.1 tag based on r30858, with rebuilt binaries (only)' \
#  svn://tug.org/texlive/trunk svn://tug.org/texlive/tags/texlive-2013.1

- update ~karl/bin/cron.tl, and reenable when feel ready.
critical=
pretest=
images_froze=true
net_frozen=false
all_frozen=false

 after release:
- texcollection
hy=/home/ftp/historic/systems/texcollection
mkdir -p $hy/$this/packaging
#
# copy files from DVD:
mount /mnt/tc
cd /mnt/tc
cp -R [A-T]* index* setup /home/ftp/historic/systems/texcollection/$this
#
# copy ctan snapshot for TUG members:
rm -i ~www/members/ctan14-*.tar # assuming it's linked!
nice -19 tar cf ~www/members/ctan15-20140531.tar ctan
chmod a=r ~www/members/ctan*.tar  # and edit members/index.html
mkdir /home/ftp/historic/systems/ctancd/$this
ln ~www/members/ctan*.tar !$  # or maybe later?
#
umount /mnt/tc
#
cd $hy/$this/packaging
# copy in files from texcollection svn, then:
pdftoppm -gray -r 222 texcoll-cover.pdf temp
# edit temp*.pgm to be just the cover.
pnmcrop temp*.pgm | pnmtopng >~www/texcollection/texcollection$this.png
cp texcoll-cover.pdf ~www/texcollection/texcollection$this.pdf
#
~www/texcollection/index.html
~www/store/index.html
/home/httpd/cgi-bin/tug-common.pl
~www/forms/current/memberapp.html 
#
~www/rss/tug.xml
~www/index.html