1MRTG-CONTRIB(1) mrtg MRTG-CONTRIB(1)
2
3
4
6 mrtg-contrib - Contribution Guidelines for MRTG
7
9 If you have written an extension to mrtg or created a bug fix, please
10 consider contributing it to the project. As I get quite a number of
11 contributions every week, here are a few guidelines which explain how
12 to contribute so that I can use the contribution without too much
13 additional work.
14
15 Translations
16 MRTG messages have been translated to a number of languages but there
17 are still many which have not been covered yet. If you want to add
18 yours, go into the mrtg-2.17.4/translate directory and follow the
19 instructions given in the README file.
20
21 Patches
22 When you have created your modification or extension to mrtg and want
23 to submit it to me, please crate a patch for the files which you have
24 modified. Do not send entire files unless they are new.
25
26 To create a patch, get hold of a copy of GNU diff (Many Unix systems
27 will have this installed already. In the NT world you might want to get
28 http://sources.redhat.com/cygwin/ to get all the nice GNU tools
29 available.) and type
30
31 diff --unified --ignore-space-change old-file new-file > simple.patch
32
33 or if you have modified several files do
34
35 diff --recursive --unified --ignore-space-change old-dir/ new-dir/ >long.patch
36
37 Documentation
38 All documentation of mrtg is done with the perl POD system. If you want
39 to learn about it, type
40
41 perldoc perlpod
42
43 and read the instructions. If you have bugfixes or additions to the
44 existing documents, make sure you modify the POD files and not the html
45 or txt versions.
46
47 I take documentation very seriously. Whenever you create a new feature
48 for mrtg which you want to get included in the official release, your
49 patch must also contain modifications for the relevant pod file in the
50 doc tree or for the documentation sections of cfgmaker and indexmaker.
51
53 Send your patches, translations and contributions to Tobias Oetiker
54 <tobi@oetiker.ch>
55
57 Tobias Oetiker <tobi@oetiker.ch>
58
59
60
612.17.4 2012-01-12 MRTG-CONTRIB(1)