cling/tools/packaging

Cling Packaging Tool (CPT)

The Cling Packaging Tool is a command-line utility to build Cling from source and generate installer bundles for a wide range of platforms.

Cling maintains its own vendor clones of LLVM and Clang (part of ROOT's trunk) on which it is based. Due to some policy restrictions we do not distribute Cling on official repositories of Debian and others. Therefore this tool is the easiest way to build Cling for your favorite platorm and bundle it into an installer. If you want to manually compile Cling from source, go through the README of Cling or the build instructions here.

Below is a list of platforms currently supported by this tool:

• Ubuntu and distros based on Debian - DEB packages
• Cygwin or Windows - NSIS installers
• Virtually any UNIX-like platform which supports Bash - Tarballs.

###Requirements Before using this tool, make sure you have the required packages installed on your system. Detailed information on what and how to install is provided below, but the recommended (and much easier) way is to use the following command which performs the required checks automatically and displays useful suggestions too specific to your platform.

cd tools/packaging/
./cpt.sh --check-requirements

####Ubuntu/Debian On Debian, Ubuntu or any other distro based on Debian which supports APT package manager, you can install all the required packages by:

sudo apt-get update
sudo apt-get install git wget debhelper devscripts gnupg python

######Setting up: Make sure GnuPG is properly set up with your correct fingerprint. These credentials are needed to sign the Debian package and create Debian changelogs. On a build machine (Electric Commander), make sure the fingerprint is of the person who is supposed to sign the official uploads. You might also want to configure GnuPG to not ask for the passphrase while signing the Debian package.

The [Ubuntu Packaging Guide] contains documentation about creating a GPG key on an Ubuntu system. [Ubuntu Packaging Guide]:http://packaging.ubuntu.com/html/getting-set-up.html#create-your-gpg-key

####Windows (Cygwin) Below is a list of required packages for Windows (Win32-x86):

[CMake] for Windows
[MSYS Git] or Git provided by Cygwin
[Cygwin]
[Python] for Windows
wget - provided by Cygwin
Microsoft Visual Studio 11 (2012), with Microsoft Visual C++ 2012 [CMake]:http://www.cmake.org/ [MSYS Git]:http://msysgit.github.io/ [Cygwin]:http://www.cygwin.com/ [Python]:https://www.python.org/

Note: Git provided by Cygwin is recommended over MSYS Git due to some known issues. ######Setting Up: Unlike other UNIX-like platforms, Windows requires you to follow some rules. Do not ignore this section unless you want CPT to fail mid-way with wierd errors. You should require these instructions only once.

• While installing the packages make sure the executable is in a path that doesn't contain spaces. For example, you should install Python in a path like

  C:\Python27
  

  rather than

  C:\Program Files (x86)\Python 2.7
  

• Path to all the required executables should be present in the Windows PATH environment variable.

• If you plan to use MSYS Git, choose the option "Run Git from Windows Command Prompt" during installation.

• Add these lines in the file ~/.bash_profile of Cygwin. UNIX files just don't run on Windows without this tweak.

  export SHELLOPTS
  set -o igncr
  

A good way to check if everything is detected properly by the script is to run the following command:

cd tools/packaging/
./cpt.sh --check-requirements

Tip: To make things easy for yourself in future, you should keep the Cygwin installer file you had downloaded previously in a safe place. Cygwin allows an easy way to install new packages through command-line. See an example below:

/cygdrive/c/cygwin/setup-x86.exe -nqP wget

###Usage

cd tools/packaging/
./cpt.sh [options]

Options:
-h|--help                     Display this message and exit
-c|--check-requirements       Check if packages required by the script are installed
--current-dev={pkg-format}    Compile the latest development snapshot and produce a package in the given format
--last-stable={pkg-format}    Compile the last stable snapshot and produce a package in the given format
--tarball-tag={tag}           Compile the snapshot of a given tag and produce a tarball
--deb-tag={tag}               Compile the snapshot of a given tag and produce a Debian package
--nsis-tag={tag}              Compile the snapshot of a given tag and produce an NSIS installer

Supported values of "pkg-format": tar | deb | nsis
Supported values of "tag": Any Git tag in Cling's repository. Example, v0.1

###Overriding Default Variables There are a select number of variables which can be set to make CPT work differently. This eliminates the need to manually edit the script. You can overrride variables by using the following syntax: $ VAR="VALUE" ./cpt.sh --current-dev=tar.

Note: Variables are case-sensitive.

List of variables in CPT which can be overridden:

• CLING_GIT_URL

  • Specify the URL of the Git repository of Cling to be used by CPT
  • Default value: "http://root.cern.ch/git/cling.git"
  • Usage: CLING_GIT_URL="http://github.com/ani07nov/cling" ./cpt.sh --last-stable=deb
  • If the source directory already contains a clone of Cling, but the supplied URL is different from the origin of the existing clone, then it is removed and a fresh clone is done.

• CLANG_GIT_URL

  • Specify the URL of the Git repository of Clang to be used by CPT
  • Default value: "http://root.cern.ch/git/clang.git"
  • Usage: CLANG_GIT_URL="http://github.com/ani07nov/clang" ./cpt.sh --last-stable=tar
  • If the source directory already contains a clone of Clang, but the supplied URL is different from the origin of the existing clone, then it is removed and a fresh clone is done.

• LLVM_GIT_URL

  • Specify the URL of the Git repository of LLVM to be used by CPT
  • Default value: "http://root.cern.ch/git/llvm.git"
  • Usage: LLVM_GIT_URL="http://github.com/ani07nov/llvm" ./cpt.sh --current-dev=tar
  • If the source directory already contains a clone of LLVM, but the supplied URL is different from the origin of the existing clone, then it is removed and a fresh clone is done.

• workdir

  • Specify the working directory of CPT. All sources will be cloned, built and installed here. The produced packages will also be found here.
  • Default value: "~/ec/build"
  • Usage: workdir="/ec/build/cling" ./cpt.sh --current-dev=deb

License

Cling Packaging Tool is a part of Cling project and released under the same license terms of Cling. You can choose to license it under the University of Illinois Open Source License or the GNU Lesser General Public License. See LICENSE.TXT for details.