From fffd13afda80aed72aabdae7b3b4bd584f9ed235 Mon Sep 17 00:00:00 2001 From: Jan Wagner Date: Tue, 23 Jul 2024 14:54:06 +0200 Subject: Update versions to reflect the actual state, we forgot about this in our last urgent release --- doc/RELEASING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/RELEASING.md b/doc/RELEASING.md index f0932bd4..cd2deaef 100644 --- a/doc/RELEASING.md +++ b/doc/RELEASING.md @@ -2,7 +2,7 @@ Releasing a New Monitoring Plugins Version ========================================== Throughout this document, it is assumed that the current Monitoring -Plugins version is 2.3.4, and that we're about to publish version 2.4. +Plugins version is 2.3.5, and that we're about to publish version 2.4. It is also assumed that the official repository on GitHub is tracked using the remote name `monitoring-plugins` (rather than `origin`). @@ -11,14 +11,14 @@ Before you start - Check Github Actions status. - Update local Git repository to the current `master` tip. For a - maintenance release (e.g., version 2.3.4), update to the current + maintenance release (e.g., version 2.3.6), update to the current `maint-2.3` tip, instead. Prepare and commit files ------------------------ - Update `configure.ac` and `NP-VERSION-GEN` with new version. -- Update `NEWS` from `git log --reverse v2.3.4..` output, and specify +- Update `NEWS` from `git log --reverse v2.3.5..` output, and specify the release version/date. - Update `AUTHORS` if there are new team members. - Update `THANKS.in` using `tools/update-thanks`. @@ -93,6 +93,6 @@ Announce new release If you want to mention the number of contributors in the announcement: - git shortlog -s v2.3.4..v2.4 | wc -l + git shortlog -s v2.3.5..v2.4 | wc -l -- cgit v1.2.3-74-g34f1 From 78f5d6b9ed62b1c7b5fcd523176a2c3f35f514b7 Mon Sep 17 00:00:00 2001 From: Jan Wagner Date: Wed, 24 Jul 2024 22:29:00 +0200 Subject: Update version in release docu --- doc/RELEASING.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'doc') diff --git a/doc/RELEASING.md b/doc/RELEASING.md index cd2deaef..e1f3bf74 100644 --- a/doc/RELEASING.md +++ b/doc/RELEASING.md @@ -2,7 +2,7 @@ Releasing a New Monitoring Plugins Version ========================================== Throughout this document, it is assumed that the current Monitoring -Plugins version is 2.3.5, and that we're about to publish version 2.4. +Plugins version is 2.4.0, and that we're about to publish version 2.5. It is also assumed that the official repository on GitHub is tracked using the remote name `monitoring-plugins` (rather than `origin`). @@ -11,14 +11,14 @@ Before you start - Check Github Actions status. - Update local Git repository to the current `master` tip. For a - maintenance release (e.g., version 2.3.6), update to the current - `maint-2.3` tip, instead. + maintenance release (e.g., version 2.4.1), update to the current + `maint-2.4` tip, instead. Prepare and commit files ------------------------ - Update `configure.ac` and `NP-VERSION-GEN` with new version. -- Update `NEWS` from `git log --reverse v2.3.5..` output, and specify +- Update `NEWS` from `git log --reverse v2.4.0..` output, and specify the release version/date. - Update `AUTHORS` if there are new team members. - Update `THANKS.in` using `tools/update-thanks`. @@ -29,27 +29,27 @@ Prepare and commit files Create annotated tag -------------------- - git tag -a -m 'Monitoring Plugins 2.4' v2.4 + git tag -a -m 'Monitoring Plugins 2.5' v2.5 Push the code and tag to GitHub ------------------------------- git push monitoring-plugins master - git push monitoring-plugins v2.4 + git push monitoring-plugins v2.5 Create new maintenance branch ----------------------------- _Only necessary when creating a feature release._ - git checkout -b maint-2.4 v2.4 - git push -u monitoring-plugins maint-2.4 + git checkout -b maint-2.5 v2.5 + git push -u monitoring-plugins maint-2.5 Checkout new version -------------------- rm -rf /tmp/plugins - git archive --prefix=tmp/plugins/ v2.4 | (cd /; tar -xf -) + git archive --prefix=tmp/plugins/ v2.5 | (cd /; tar -xf -) Build the tarball ----------------- @@ -62,26 +62,26 @@ Build the tarball Upload tarball to web site -------------------------- - scp monitoring-plugins-2.4.tar.gz \ + scp monitoring-plugins-2.5.tar.gz \ plugins@orwell.monitoring-plugins.org:web/download/ Generate SHA1 checksum file on web site --------------------------------------- ssh plugins@orwell.monitoring-plugins.org \ - '(cd web/download; $HOME/bin/create-checksum monitoring-plugins-2.4.tar.gz)' + '(cd web/download; $HOME/bin/create-checksum monitoring-plugins-2.5.tar.gz)' Announce new release -------------------- - In the site.git repository: - - Create `web/input/news/release-2-4.md`. + - Create `web/input/news/release-2.5.md`. - Update the `plugins_release` version in `web/macros.py`. - Commit and push the result: - git add web/input/news/release-2-4.md - git commit web/input/news/release-2-4.md web/macros.py + git add web/input/news/release-2.5.md + git commit web/input/news/release-2.5.md web/macros.py git push origin master - Post an announcement on (at least) the following mailing lists: @@ -93,6 +93,6 @@ Announce new release If you want to mention the number of contributors in the announcement: - git shortlog -s v2.3.5..v2.4 | wc -l + git shortlog -s v2.4.0..v2.5 | wc -l -- cgit v1.2.3-74-g34f1 From 0d61e6d126817ee38582eea307c9feecf75330f9 Mon Sep 17 00:00:00 2001 From: RincewindsHat <12514511+RincewindsHat@users.noreply.github.com> Date: Tue, 15 Oct 2024 09:32:09 +0200 Subject: docs: update copyright and remove revision section --- doc/developer-guidelines.sgml | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) (limited to 'doc') diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 37c963ed..edadaad0 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml @@ -14,15 +14,8 @@ 2013 Monitoring Plugins Development Guidelines - - - 1796 - 2007-09-24 14:51:07 -0400 (Mon, 24 Sep 2007) - - - - 2000 - 2013 + 2000 - 2024 Monitoring Plugins Development Team @@ -34,7 +27,7 @@ the plugin developers and encourage the standardization of the different kind of plugins: C, shell, perl, python, etc. - Monitoring Plugins Development Guidelines Copyright (C) 2000-2013 + Monitoring Plugins Development Guidelines Copyright (C) 2000-2024 (Monitoring Plugins Team) Permission is granted to make and distribute verbatim -- cgit v1.2.3-74-g34f1 From 2b1b5c1ce9c70df9853fa4ac01d740d6a7e45d37 Mon Sep 17 00:00:00 2001 From: RincewindsHat <12514511+RincewindsHat@users.noreply.github.com> Date: Tue, 15 Oct 2024 09:32:28 +0200 Subject: Docs: remove sections about translation This commit removes the sections about translations, because, well, we removed translations a while ago. The documentation should reflect that. --- doc/developer-guidelines.sgml | 33 --------------------------------- 1 file changed, 33 deletions(-) (limited to 'doc') diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index edadaad0..4186ed7f 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml @@ -376,13 +376,6 @@ It is up to third party programs to convert the Monitoring Plugins performance data into graphs. - -
Translations - If possible, use translation tools for all output to respect the user's language - settings. See for guidelines - for the core plugins. - -
System Commands and Auxiliary Files @@ -749,32 +742,6 @@ setup the tests. Run "make test" to run all the tests. All commits will be written to a ChangeLog at release time.
- -
Translations for developers - To make the job easier for translators, please follow these guidelines: - - - Before creating new strings, check the po/monitoring-plugins.pot file to - see if a similar string - already exists - - - For help texts, break into individual options so that these can be reused - between plugins - - Try to avoid linefeeds unless you are working on a block of text - Short help is not translated - Long help has options in English language, but text translated - "Copyright" kept in English - Copyright holder names kept in original text - Debugging output does not need to be translated - -
- -
Translations for translators - To create an up to date list of translatable strings, run: tools/gen_locale.sh -
-
Submission of new plugins and patches -- cgit v1.2.3-74-g34f1 From 1b293a4032dfa87b8eeee5695ebe0c74a2b9a413 Mon Sep 17 00:00:00 2001 From: RincewindsHat <12514511+RincewindsHat@users.noreply.github.com> Date: Tue, 15 Oct 2024 09:33:34 +0200 Subject: Adapted the coding guidelines slightly + typo --- doc/developer-guidelines.sgml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 4186ed7f..0afa733b 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml @@ -713,19 +713,18 @@ setup the tests. Run "make test" to run all the tests.
Coding guidelines See GNU - Coding standards for general guidelines. + Coding standards for general guidelines. + Some parts of the guidelines (namely and explicitly the coding style) + are not seen as best practice by us.
C coding - Variables should be declared at the beginning of code blocks and - not inline because of portability with older compilers. - You should use the type "bool" and its values "true" and "false" instead of the "int" type for booleans.
Crediting sources - If you have copied a routine from another source, make sure the licence + If you have copied a routine from another source, make sure the license from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS file, where you can put more detail about the source. For contributed code, do not add any named credits in the source code -- cgit v1.2.3-74-g34f1