Packaging a Documentation Distribution

Follow these instructions to build a Cygwin/X documentation source code distribution:

  1. Edit the version tag in the file configure.ac to indicate a new version. The line containing the version tag should look like:

    
AC_INIT(cygwin-x-doc, 1.0.0)
    
  2. Commit this change to git and apply an appropriate tag:
    
Username@CygwinHost ~/cygwin-x-doc-1.0.0
    $ git add configure.ac
    Username@CygwinHost ~/cygwin-x-doc-1.0.0
    $ git commit -m "Bump version to 1.0.0"
    [...]
    Username@CygwinHost ~/cygwin-x-doc-1.0.0
    $ git tag VERSION_1_0_0
    

  3. Change the current directory to the documentation source code build directory:

    
Username@CygwinHost ~/cygwin-x-doc-1.0.0
    $ cd cygwin-x-doc-1.0.0/build
    
    Username@CygwinHost ~/cygwin-x-doc-1.0.0/build
    $
    
  4. Build the documentation source code distribution:

    
Username@CygwinHost ~/cygwin-x-doc-1.0.0/build
    $ make distcheck
    
  5. The documentation source code distribution should now be contained in the current directory in a file called cygwin-x-doc-1.0.0.tar.bz2.

  6. Packaging the documentation is now complete.