1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
<HTML>
<HEAD>
<TITLE>doc/contrib</TITLE>
<LINK REV="made" HREF="mailto:karrer@iis.ee.ethz.ch">
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#990200" VLINK="#006342"><P><IMG SRC="mrtg-l.png"><IMG SRC="mrtg-m.png"><IMG SRC="mrtg-r.gif"></P>
<A NAME="__index__"></A>
<!-- INDEX BEGIN -->
<!--
<UL>
<LI><A HREF="#name">NAME</A></LI>
<LI><A HREF="#synopsis">SYNOPSIS</A></LI>
<LI><A HREF="#translations">TRANSLATIONS</A></LI>
<LI><A HREF="#documentation">DOCUMENTATION</A></LI>
<LI><A HREF="#patches">PATCHES</A></LI>
<LI><A HREF="#documentation">DOCUMENTATION</A></LI>
<LI><A HREF="#address">ADDRESS</A></LI>
<LI><A HREF="#author">AUTHOR</A></LI>
</UL>
-->
<!-- INDEX END -->
<P>
<H1><A NAME="name">NAME</A></H1>
<P>contrib - Contribution Guidelines for MRTG</P>
<P>
<HR>
<H1><A NAME="synopsis">SYNOPSIS</A></H1>
<P>If you have written an extension to mrtg or created a bug fix, please
consider contributing it to the project. As I get quite a number of
contributions every week, here are a few guide lines which explain how to
contribute so that I can use the contribution without too much additional
work.</P>
<P>
<HR>
<H1><A NAME="translations">TRANSLATIONS</A></H1>
<P>MRTG messages have been translated to a number of languages. But there are
still many which have not been covered yet. If you want to add yours, go
into the <EM>mrtg-2.9.17/translate</EM> directory, and follow the instructions
given in the <EM>README</EM> file.</P>
<P>
<HR>
<H1><A NAME="documentation">DOCUMENTATION</A></H1>
<P>All documentation of mrtg is done with the perl <STRONG>POD</STRONG> system. If you want to
learn about it, type</P>
<PRE>
perldoc perlpod</PRE>
<P>and read the instructions. If you have bug fixes of additions to the existing
documents, make sure you modify the <STRONG>POD</STRONG> files and not the HTML or txt
versions.</P>
<P>
<HR>
<H1><A NAME="patches">PATCHES</A></H1>
<P>When you have created your modification or extension to mrtg and want to
submit it to me, please create a patch for the files which you have modified.
Do not send entire files unless they are new.</P>
<P>To create a patch, get hold of a copy of GNU diff (Many Unix systems will
have this installed already. In the NT world you might want to get
<A HREF="http://sources.redhat.com/cygwin/">http://sources.redhat.com/cygwin/</A> to get all the nice GNU tools available.)
and type</P>
<PRE>
diff --unified --ignore-space-change file.orig file > simple.patch</PRE>
<P>or if you have modified several files do</P>
<PRE>
diff --recursive --unified --ignore-space-change dir.orig/ dir/ >long.patch</PRE>
<P>
<HR>
<H1><A NAME="documentation">DOCUMENTATION</A></H1>
<P>I take documentation very seriously. When ever you create a new feature for
mrtg which you want to get included in the official release your patch must
also contain modifications for the relevant pod file in the <EM>doc</EM> tree or
for the documentation sections of <EM>cfgmaker</EM> and <EM>indexmaker</EM>.</P>
<P>
<HR>
<H1><A NAME="address">ADDRESS</A></H1>
<P>Send your patches, translations and contributions to Tobias Oetiker <<A HREF="mailto:oetiker@ee.ethz.ch">oetiker@ee.ethz.ch</A>></P>
<P>
<HR>
<H1><A NAME="author">AUTHOR</A></H1>
<P>Tobias Oetiker <<A HREF="mailto:oetiker@ee.ethz.ch">oetiker@ee.ethz.ch</A>></P>
</BODY>
</HTML>
|
