README.DIST

   1 How to create SILC distributions
   2 ================================
   3
   4 This document describes how to prepare SILC distributions in SILC source
   5 tree and how to package distributions for releasing.  This also defines
   6 the procedure what one should do when distribution is created for
   7 releasing.
   8
   9
  10 The 'distributions' file
  11 ========================
  12
  13 The 'distributions' file descibres all distributions that can be created
  14 from the SILC CVS source tree.  You should read that file if you want to
  15 learn how to create new distributions.  The file already defines the main
  16 distributions that can be created from the soure tree.  These are the
  17 'client', 'server' and 'toolkit' distributions.
  18
  19
  20 Preparing distribution
  21 ======================
  22
  23 The SILC CVS source tree must be prepared before it can be configured,
  24 compiled and packaged.  The ./prepare script is used to prepare
  25 distribution for configuration, compilation and packaging.  To prepare a
  26 specific distribution with specific version, give command:
  27
  28         ./prepare <name> <version>
  29
  30 Where the <name> is the distribution name.  It is one of the distributions
  31 that was defined in 'distributions' file.  The <version> is the version of
  32 the distribution that will be prepared.  The version format is
  33 major.minor.build, for example 0.9.10.  Example:
  34
  35         ./prepare client 0.9.15
  36
  37 This prepares 'client' distribution of version 0.9.15.  The package will
  38 have the version 0.9.15 automatically.
  39
  40 NOTE for 'toolkit' distribution:  The toolkit version is defined in the
  41 'prepare' file itself.  Edit the SILC_VERSION variable inside the
  42 'prepare' script, and then run the prepare without the version argument.
  43
  44
  45 Configuring and compiling the distribution
  46 ==========================================
  47
  48 When you prepare the distribution for releasing you should configure the
  49 distribution without any specific configuration options, hence just give
  50 the command:
  51
  52         ./configure
  53
  54 To compile the distribution, give command:
  55
  56         make
  57
  58 If you want you can clear the environment first with make clean command,
  59 but this is not necessary.
  60
  61
  62 Packaging the distribution
  63 ==========================
  64
  65 After the distribution is prepared, configured and compiled it can be
  66 packaged with the following commands:
  67
  68         make dist
  69         make dist-bzip
  70
  71 The first command creates a gzipped distribution and the second creates a
  72 bzipped distribution.
  73
  74 NOTE:  Before giving this command, make sure that you do not have any of
  75 the tests in the SILC source tree compiled.  If they are the binaries
  76 will be included in the distribution which is not allowed.  The tests are
  77 always located in the tests/ directory, for example lib/silccore/tests/.
  78 The tests are not compiled by default, but if you compiled them by
  79 yourself make sure you make clean them before creating the distribution.
  80
  81 NOTE:  Same thing must be assured for silcer/ and tutorial/ sub
  82 directories.  Make sure they are not compiled and does not include any
  83 extra files.  If you haven't compiled them after the CVS checkout, they do
  84 not include any extra files.
  85
  86 NOTE for 'toolkit' distribution:  Before giving make dist the following
  87 must be done:
  88
  89         go to util/robodoc/
  90         give ./configure;make to compile robodoc
  91         go to doc/
  92         give make toolkit-ref-html
  93
  94 This then creates the Toolkit reference manual.  After this the toolkit
  95 distribution can be packaged.
  96
  97
  98 Before releasing the distribution
  99 =================================
 100
 101 Before releasing the distribution the created distribution must be tagged
 102 in the CVS so that it can be checkout at a later time, if needed.  The tag
 103 format is as follows:
 104
 105         silc_<name>_<version>
 106
 107 Where <name> is the distribution name and <version> is the version of the
 108 distribution in following format: major_minor_build, for example 0_9_10.
 109 Example:
 110
 111         silc_client_0_9_15
 112
 113 To tag the distribution go to the root of the SILC CVS source tree and
 114 give, for example, command:
 115
 116         cvs tag silc_client_0_9_15