remove changelog entry for undone update
[silc.git] / README.DIST
index 473a817f8a60c4737634ef118e1c3b6dc384ce70..fb08e833ae85931d951be881762d52987a72cc17 100644 (file)
@@ -1,4 +1,4 @@
-How to Create SILC distributions
+How to create SILC distributions
 ================================
 
 This document describes how to prepare SILC distributions in SILC source
@@ -6,41 +6,29 @@ tree and how to package distributions for releasing.  This also defines
 the procedure what one should do when distribution is created for
 releasing.
 
-
-The 'distributions' file
-========================
-
-The 'distributions' file descibres all distributions that can be created 
-from the SILC CVS source tree.  You should read that file if you want to 
-learn how to create new distributions.  The file already defines the main 
-distributions that can be created from the soure tree.  These are the 
-'client, 'server' and 'toolkit' distributions.
+The distdir/ directory contains all distributions that can be created
+from the source tree.  The distdir/default cannot be packaged, it must
+be used only for development.
 
 
 Preparing distribution
 ======================
 
-The SILC CVS source tree must be prepared before it can be configured, 
-compiled and packaged.  The ./prepare script is used to prepare 
-distribution for configuration, compilation and packaging.  To prepare a 
-specific distribution with specific version, give command:
+To prepare a specific distribution with specific version for packaging,
+give command:
 
-       ./prepare <name> <version>
+       autodist <name> <version>
 
 Where the <name> is the distribution name.  It is one of the distributions 
-that was defined in 'distributions' file.  The <version> is the version of 
+that was defined in distdir/ directory.  The <version> is the version of 
 the distribution that will be prepared.  The version format is 
 major.minor.build, for example 0.9.10.  Example:
 
-       ./prepare client 0.9.15
+       autodist client 0.9.15
 
 This prepares 'client' distribution of version 0.9.15.  The package will 
 have the version 0.9.15 automatically.
 
-NOTE for 'toolkit' distribution:  The toolkit version is defined in the 
-'prepare' file itself.  Edit the SILC_VERSION variable inside the 
-'prepare' script, and then run the prepare without the version argument.
-
 
 Configuring and compiling the distribution
 ==========================================
@@ -65,11 +53,11 @@ Packaging the distribution
 After the distribution is prepared, configured and compiled it can be 
 packaged with the following commands:
 
-       make dist
-       make dist-bzip
+       make -C doc dist-hook
+       makedist --bzip2
 
-The first command creates a gzipped distribution and the second creates a
-bzipped distribution.
+The 'makedist --bzip2' creates the default 'tar.gz' and 'tar.bz2' 
+distribution.
 
 NOTE:  Before giving this command, make sure that you do not have any of 
 the tests in the SILC source tree compiled.  If they are the binaries
@@ -83,16 +71,14 @@ directories.  Make sure they are not compiled and does not include any
 extra files.  If you haven't compiled them after the CVS checkout, they do
 not include any extra files.
 
-NOTE for 'toolkit' distribution:  Before giving make dist the following
-must be done:
+NOTE: The default make command use by autodist is gmake. You can change
+this by editing distdir/autodist.conf.
 
-       go to util/robodoc/
-       give ./configure;make to compile robodoc
-       go to doc/
-       give make toolkit-ref-html
+NOTE for 'toolkit' distribution:  Running ./configure for toolkit 
+distribution is not necessary.  Toolkit is packaged simply by giving 
+command:
 
-This then creates the Toolkit reference manual.  After this the toolkit 
-distribution can be packaged.
+       makedist
 
 
 Before releasing the distribution