anonscm.debian.org Git - pkg-nagios/pkg-nagios-plugins-contrib/blob - debian/README.source

   1 nagios-plugins-contrib - Plugins for nagios compatible monitoring systems
   2 --------------------------------------------------------------------------
   3
   4
   5 This README.source should give a short instruction about the
   6 way the pkg-nagios-plugins-contrib repository is structured
   7 and defines basic policies.
   8
   9 * build-system: git-buildpackage. As we build a Debian native
  10   package pristine-tar is not necessary.
  11
  12 * debian/changelog:
  13   - preferable generated using git-dch
  14   - versioning schema: X.$(date '+%Y%m%d'). X will be
  15     increased by one with each release. In case there are
  16     bugfixes in stable releases necessary, use
  17     X.$(date '+%Y%m%d').Y
  18     See http://kitenet.net/~joey/blog/entry/version_numbers/
  19     for details.
  20
  21 * debian/copyright.in, debian/control.in:
  22   Base files we fill automatically with information from
  23   all plugins to generate the full files.
  24   This is done in the clean target.
  25   DO NOT MODIFY debian/control or debian/copyright!
  26
  27 * nagios plugins:
  28   - one directory per plugin
  29   - required files:
  30     * $plugin/control: file format similar to debian/control.
  31       - Required is the Description and Uploaders part.
  32         Add Build-Depends, Recommends, Suggests
  33         and Homepage to have their content added to debian/control/
  34         debian/copyright. Don't use Depends as we don't want to force
  35         people to install dependencies for a plugin they might not
  36         want to use.
  37       - Add Version to be able to track an upstream version of
  38         the plugin.
  39       - Add Watch to check for new versions using
  40         ./debian/packaging-helper.py
  41         Format:
  42         Watch URL python-regex
  43         Watch URL SHA1:sha1sum
  44       - Don't add empty lines - only the first paragraph will be
  45         handled.
  46     * $plugin/copyright: copyright information for the files
  47       in $plugin. Will be added to debian/copyright
  48       automatically, properly indented and with a header which
  49       describes that the coming block is for the files in $plugin.
  50       ** DEP-5 IS NOT SUPPORTED **
  51   - what you should have:
  52     Currently there are two options on how to build and install
  53     plugins:
  54     * you have a single script or file or need some hand-made
  55       build system anyway:
  56       add $plugin/Makefile and implement the all / install / clean
  57       targets. include ../common.mk is there for common tasks.
  58       If $plugin/Makefile exists the way described below *will not*
  59       be built.
  60     * your plugin comes with a fancy build system already:
  61       extract the source in $plugin and let a symlink called 'src'
  62       point to the subdirectory of $plugin.
  63       If dh_auto_* is not able to build the plugin, please use
  64       the Makefile way as described above.
  65     Please ensure that a proper .cfg file will be installed.
  66