MRTG-CONTRIB(1)

💖 MRTG-CONTRIB(1) 💖

okay bestie, gather round — this is the contribution guide for mrtg, section 1 of the manual. If you've got something to give back, this is your moment. ✨

🌸 NAME 🌸

mrtg-contrib — Contribution Guidelines for MRTG 🫶

🦋 DESCRIPTION 🦋

So here's the vibe: if you've written an extension to mrtg, or you've cooked up a bug fix, please consider contributing it to the project. The thing is, a lot of contributions land in the inbox every single week, so there are a few guidelines here explaining how to submit your stuff — the whole point is that the maintainer can actually use your contribution without too much additional work. Lowkey the nicest gift you can give. 💅

🎀 Translations 🎀

MRTG messages have already been translated into a bunch of languages, but there are still many which have not been covered yet. If you want to add yours, go into the mrtg-2.17.10/translate directory and follow the instructions given in the README file. no cap, it's that easy. 🌈

🌟 Patches 🌟

When you've created your modification or extension to mrtg and want to submit it, please create a patch for the files which you have modified. Do not send entire files unless they are new. (like, nobody wants the whole file bestie, just the diff 🙈)

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 grab http://sources.redhat.com/cygwin/ to get all the nice GNU tools available. 💻

Then type:

diff --unified --ignore-space-change old-file new-file > simple.patch

or, if you have modified several files, do:

diff --recursive --unified --ignore-space-change old-dir/ new-dir/ >long.patch

(yes the second one is long.patch, no space, that's not a typo, that's just how it is 🧚)

📚 Documentation 📚

All documentation of mrtg is done with the perl POD system. If you want to learn about it, type:

perldoc perlpod

and read the instructions. If you have bugfixes or additions to the existing documents, make sure you modify the POD files and not the html or txt versions. fr fr, the POD is the source of truth. 👑

I take documentation very seriously. 😤 Whenever 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 doc tree, or for the documentation sections of cfgmaker and indexmaker.

💌 ADDRESS 💌

Send your patches, translations and contributions to Tobias Oetiker <tobi@oetiker.ch> 📮

👑 AUTHOR 👑

Tobias Oetiker <tobi@oetiker.ch> 💜

and that's the whole page, bestie — go forth and contribute, you're gonna ate 💅✨

this was mrtg manual page MRTG-CONTRIB(1), version 2.17.10, dated 2022-01-19. mwah 🎀