From 8a1f6b17698974a1e36c1f0134e4bc4c51c7539f Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Wed, 1 Oct 2008 10:44:56 +0200 Subject: added doc on how to build from source repository --- doc/Makefile.am | 1 + doc/build_from_repo.html | 54 ++++++++++++++++++++++++++++++++++++++++++++++++ doc/install.html | 19 ++++++++++++++--- doc/manual.html | 1 + doc/rsyslog_conf.html | 3 +-- 5 files changed, 73 insertions(+), 5 deletions(-) create mode 100644 doc/build_from_repo.html (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 948cb719..34990d90 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -8,6 +8,7 @@ html_files = \ history.html \ how2help.html \ install.html \ + build_from_repo.html \ ipv6.html \ log_rotation_fix_size.html \ manual.html \ diff --git a/doc/build_from_repo.html b/doc/build_from_repo.html new file mode 100644 index 00000000..8d3b20fe --- /dev/null +++ b/doc/build_from_repo.html @@ -0,0 +1,54 @@ + +Building rsyslog from the source repository + + +

Building rsyslog from the source repository

+

In most cases, people install rsyslog either via a package or use an "official" +distribution tarball to generate it. But there may be situations where it is desirable +to build directly from the source repository. This is useful for people who would like to +participate in development or who would like to use the latest, not-yet-released code. +The later may especially be the case if you are asked to try out an experimental version. +

Building from the repsitory is not much different than building from the source +tarball, but some files are missing because they are output files and thus do not +belong into the repository. +

Obtaining the Source

+

First of all, you need to download the sources. Rsyslog is currently kept in a git +repository. You can clone this repository either via http or git protocol (with the later +being much faster. URLS are: +

+

There is also a browsable version (gitweb) available at +http://git.adiscon.com/?p=rsyslog.git;a=summary. +This version also offers snapshots of each commit for easy download. You can use these if +you do not have git present on your system. +

After you have cloned the repository, you are in the master branch by default. This +is where we keep the devel branch. If you need any other branch, you need to do +a "git checkout --track -b branch origin/branch". For example, the command to check out +the beta branch is "git checkout --track -b beta origin/beta". +

Prequisites

+

To build the compilation system, you need the pkg-config package (an utility for +autotools) present on your system. Otherwise, configure will fail with something like +


+checking for SYSLOG_UNIXAF support... yes
+checking for FSSTND support... yes
+./configure: line 25895: syntax error near unexpected token `RELP,'
+./configure: line 25895: ` PKG_CHECK_MODULES(RELP, relp >= 0.1.1)'
+
+

Creating the Build Environment

+

This is fairly easy: just issue "autoreconf -fvi", which should do everything you need. +Once this is done, you can follow the usual ./configure steps just like when +you downloaded an official distribution tarball (see the +rsyslog install guide, starting at step 2, +for further details about that). + +

[manual index] +[rsyslog site]

+

This documentation is part of the +rsyslog project.
+Copyright © 2008 by Rainer Gerhards and +Adiscon. Released under the GNU GPL +version 1.2 or higher.

+ + diff --git a/doc/install.html b/doc/install.html index 661ae943..48b7f649 100644 --- a/doc/install.html +++ b/doc/install.html @@ -24,7 +24,11 @@ you volunteer to create one, drop me a line). Thus, this guide focuses on installing from the source, which thankfully is quite easy.

Step 1 - Download Software

-

For obvious reasons, you need to download rsyslog. Load the most recent build +

For obvious reasons, you need to download rsyslog. Here, I assume that you +use a distribution tarball. If you would like to use a version directly from +the repository, see build rsyslog from repository +instead. +

Load the most recent build from http://www.rsyslog.com/downloads. Extract the software with "tar xzf -nameOfDownloadSet-". This will create a new subdirectory rsyslog-version in the current working directory. CD into that.

@@ -150,9 +154,12 @@ comments or bug sighting reports are very welcome. Please
  • 2007-07-13 * Rainer Gerhards  * updated to new autotools-based build system
    • +
  • 2008-10-01 * + Rainer Gerhards  + * added info on building from source repository

    • Copyright

    -

    Copyright (c) 2005, 2007 +

    Copyright © 2005-2008 Rainer Gerhards and Adiscon.

    Permission is granted to copy, distribute and/or modify this document @@ -162,6 +169,12 @@ comments or bug sighting reports are very welcome. Please Texts. A copy of the license can be viewed at http://www.gnu.org/copyleft/fdl.html.

    - +

    [manual index] +[rsyslog site]

    +

    This documentation is part of the +rsyslog project.
    +Copyright © 2008 by Rainer Gerhards and +Adiscon. Released under the GNU GPL +version 1.2 or higher.

    diff --git a/doc/manual.html b/doc/manual.html index ec0303c3..f0c02fd2 100644 --- a/doc/manual.html +++ b/doc/manual.html @@ -50,6 +50,7 @@ modules
  • rsyslogd man page

    We have some in-depth papers on