Fix null ptr exception in Zone::GetLocalZone()

[icinga2] / INSTALL

diff --git a/INSTALL b/INSTALL
index a991ce12b17b54ad535f3794e218610cee3f78a3..a3402425abe774c8b144bf505f6ed13374d84d22 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,15 +1,17 @@
 Installing Icinga 2
 ===================
 
-Please note that the current version of Icinga 2 isn't much more than a tech
-demo. Expect some rough edges when installing and running Icinga 2.
-
-For the "finished" version we're planning to release packages for the most
-common Linux distributions as well as for Windows - or at least co-operate
-with the package maintainers.
+The recommended way of installing Icinga 2 is to use packages. The Icinga
+project provides both release and development packages for a number
+of operating systems.
 
 Please check the documentation in the doc/ directory for a current list
-of available packages.
+of available packages and detailed installation instructions.
+
+There are a number of known caveats when installing from source such as
+incorrect directory and file permissions. So even if you're planning to
+not use the official packages it is advisable to build your own Debian
+or RPM packages.
 
 Build Requirements
 ------------------
@@ -28,7 +30,6 @@ parentheses):
 * GNU bison (bison)
 * GNU flex (flex) >= 2.5.35
 * recommended: libexecinfo on FreeBSD
-* optional: Doxygen (doxygen)
 * optional: MySQL (mysql-devel on RHEL, libmysqlclient-dev on Debian)
 * optional: Python (python-devel on RHEL, python-dev on Debian)
 
@@ -37,7 +38,6 @@ example from the repoforge buildtools repository.
 
 http://mirror.hs-esslingen.de/repoforge/redhat/el5/en/{i386,x86_64}/buildtools/
 
-
 User Requirements
 -----------------
 
@@ -59,6 +59,38 @@ permissions to the external command pipe and livestatus socket:
 Make sure to replace "www-data" with the name of the user your web server
 is running as.
 
+Building Release Tarballs
+-------------------------
+
+In order to build a release tarball you should first check out the Git repository
+in a new directory. If you're using an existing check-out you should make sure
+that there are no local modifications:
+
+$ git status
+
+Here's a short check-list for releases:
+
+* Bump the version in icinga2.spec.
+* Update the ChangeLog and doc/1-about.md files.
+* Commit these changes to the "next" branch and create a signed tag (tags/v<VERSION>).
+* Merge the "next" branch into the "master" branch (using --ff-only).
+* Bump the version to "v<NEXT-VERSION>-dev" and commit this change to the "next" branch.
+
+Note: CMake determines the Icinga 2 version number using "git describe" if the
+source directory is contained in a Git repository. Otherwise the version number
+is extracted from the icinga2.spec file. This behavior can be overridden by
+creating a file called "icinga-version.h.force" in the source directory.
+Alternatively the -DICINGA2_GIT_VERSION_INFO=ON option for CMake can be used to
+disable the usage of "git describe".
+
+Use "git archive" to build the release tarball:
+
+$ git archive --format=tgz --prefix=icinga2-<VERSION>/ tags/v<VERSION>
+
+Finally you should verify that the tarball only contains the files it should contain:
+
+$ tar ztf icinga2-<VERSION>.tar.gz | less
+
 Building Icinga 2
 -----------------
 
@@ -109,16 +141,3 @@ configuration format is explained in detail in the doc/ directory.
 By default "make install" installs example configuration files in
 /usr/local/etc/icinga2 unless you have specified a different prefix or
 sysconfdir.
-
-
-Package Builds
---------------
-
-In order to create a snapshot tarball, create a new release directory outside
-the source tree and run cmake and make. Replace <version> with the correct
-string.
-
-$ cd ..
-$ mkdir icinga2-release && cd icinga2-release
-$ cmake ../icinga2 -DCPACK_SOURCE_GENERATE=TGZ -DCPACK_SOURCE_PACKAGE_FILE_NAME=icinga2-<version>
-$ make package_source