From 237205f0cf33773d4a8501074a7584a631af7301 Mon Sep 17 00:00:00 2001 From: Quentin Garnier Date: Wed, 24 Dec 2014 14:39:09 +0100 Subject: [PATCH] + Some typo doc fix --- docs/developer/guide.rst | 14 ++++++-------- docs/user/guide.rst | 4 ++-- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/developer/guide.rst b/docs/developer/guide.rst index 0f7e0c051..5ddc95880 100644 --- a/docs/developer/guide.rst +++ b/docs/developer/guide.rst @@ -28,7 +28,7 @@ Root directories are organized by section : * Operating System : os * Storage equipment : storage -According to the monitored object, there exists an organization which can use : +According to the monitored object, it exists an organization which can use : * Type * Constructor @@ -38,12 +38,12 @@ According to the monitored object, there exists an organization which can use : For example, if you want to add a plugin to monitor Linux by SNMP, you need to create this directory : :: - mkdir -p os/linux/snmp + $ mkdir -p os/linux/snmp You also need to create a "mode" directory for futures modes : :: - mkdir os/linux/snmp/mode + $ mkdir os/linux/snmp/mode --------------- Plugin creation @@ -52,7 +52,7 @@ Plugin creation Once the directory is created, create the plugin file inside it : :: - touch plugin.pm + $ touch plugin.pm Then, edit plugin.pm to add **license terms** by copying it from an other plugin. Don't forget to put your name at the end of it : @@ -83,7 +83,7 @@ The plugin need a **new** function to instantiate the object : my ($class, %options) = @_; my $self = $class->SUPER::new(package => __PACKAGE__, %options); bless $self, $class; - + ... return $self; @@ -130,7 +130,6 @@ A description of the plugin is needed to generate the documentation : .. tip:: plugin has ".pm" extension because it's a perl module. So don't forget to add **1;** at the end of the file - ------------- Mode creation ------------- @@ -162,7 +161,7 @@ Declare used libraries (always the same) : use warnings; use base qw(centreon::plugins::mode); -The mode need a **new** function to instantiate the object : +The mode needs a **new** function to instantiate the object : .. code-block:: perl @@ -283,7 +282,6 @@ A description of the mode and its arguments is needed to generate the documentat =cut - --------------- Commit and push --------------- diff --git a/docs/user/guide.rst b/docs/user/guide.rst index 3d44ffd1f..205c3b43b 100644 --- a/docs/user/guide.rst +++ b/docs/user/guide.rst @@ -481,7 +481,7 @@ I use an option but it doesn't seem to work Before opening a ticket on the forge, please use the option ``--sanity-options``. It checks if you have misspell an option: :: - $ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=traffic --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --interface='.*' --name --regex --verbose --skip --skip-speed0 --sanity-options + $ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=traffic --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --interface='.*' --name --regex --verbose --skip --skip-speed0 --sanity-options Unknown option: regex I get the error: "UNKNOWN: Need to specify '--custommode'." @@ -515,7 +515,7 @@ I can't see help messages "centreon-plugins" files must unix format (no windows carriage returns). You can change it with the following command: :: - $ find . -name "*.p[ml]" -type f -exec dos2unix \{\} \; + $ find . -name "*.p[ml]" -type f -exec dos2unix \{\} \; .. Warning:: Execute the command in "centreon-plugins" directory.