Update typographic errors and explain things in the help messages (#1968

) * Fix typographic error librairy -> library * Update help message for --debug flag The message for --debug is not obvious because it doesn't explain that it enables a different logging scheme (a more verbose log is captured). Additionally, self-claiming that the program is bug-free is not very useful when you're debugging a serious bug.
shinken-solutions · Jul 16, 2019 · 70ce924 · 70ce924
1 parent 546448a
commit 70ce924
Show file tree

Hide file tree

Showing 19 changed files with 31 additions and 31 deletions.
diff --git a/bin/shinken-arbiter b/bin/shinken-arbiter
@@ -88,14 +88,14 @@ def main():
                       dest="do_replace",
                       help="Replace previous running arbiter")
     parser.add_option('--debugfile', dest='debug_file',
-                      help=("Debug file. Default: not used "
-                            "(why debug a bug free program? :) )"))
+                      help=("Enable debug log and save it to a file. "
+                            "Default: not used"))
     parser.add_option("-v", "--verify-config",
                       dest="verify_only", action="store_true",
                       help="Verify config file and exit")
     parser.add_option("-p", "--profile",
                       dest="profile",
-                      help="Dump a profile file. Need the python cProfile librairy")
+                      help="Dump a profile file. Need the python cProfile library")
     parser.add_option("-a", "--analyse",
                       dest="analyse",
                       help="Dump an analyse statistics file, for support")

diff --git a/bin/shinken-broker b/bin/shinken-broker
@@ -75,11 +75,11 @@ def main():
                       dest="do_replace",
                       help="Replace previous running broker")
     parser.add_option('--debugfile', dest='debug_file',
-                      help=("Debug file. Default: not used "
-                            "(why debug a bug free program? :) )"))
+                      help=("Enable debug log and save it to a file. "
+                            "Default: not used"))
     parser.add_option("-p", "--profile",
                       dest="profile",
-                      help="Dump a profile file. Need the python cProfile librairy")
+                      help="Dump a profile file. Need the python cProfile library")
 
     opts, args = parser.parse_args()
     if args:

diff --git a/bin/shinken-poller b/bin/shinken-poller
@@ -76,11 +76,11 @@ def main():
                       dest="do_replace",
                       help="Replace previous running poller")
     parser.add_option('--debugfile', dest='debug_file',
-                      help=("Debug file. Default: not used "
-                            "(why debug a bug free program? :) )"))
+                      help=("Enable debug log and save it to a file. "
+                            "Default: not used"))
     parser.add_option("-p", "--profile",
                       dest="profile",
-                      help="Dump a profile file. Need the python cProfile librairy")
+                      help="Dump a profile file. Need the python cProfile library")
 
     opts, args = parser.parse_args()
     if args:

diff --git a/bin/shinken-reactionner b/bin/shinken-reactionner
@@ -89,11 +89,11 @@ def main():
                       dest="do_replace",
                       help="Replace previous running reactionner")
     parser.add_option('--debugfile', dest='debug_file',
-                      help=("Debug file. Default: not used "
-                            "(why debug a bug free program? :) )"))
+                      help=("Enable debug log and save it to a file. "
+                            "Default: not used"))
     parser.add_option("-p", "--profile",
                       dest="profile",
-                      help="Dump a profile file. Need the python cProfile librairy")
+                      help="Dump a profile file. Need the python cProfile library")
 
     opts, args = parser.parse_args()
     if args:

diff --git a/bin/shinken-receiver b/bin/shinken-receiver
@@ -76,8 +76,8 @@ def main():
                       dest="do_replace",
                       help="Replace previous running receiver")
     parser.add_option('--debugfile', dest='debug_file',
-                      help=("Debug file. Default: not used "
-                            "(why debug a bug free program? :) )"))
+                      help=("Enable debug log and save it to a file. "
+                            "Default: not used"))
     opts, args = parser.parse_args()
     if args:
         parser.error("Does not accept any argument.")

diff --git a/bin/shinken-scheduler b/bin/shinken-scheduler
@@ -122,11 +122,11 @@ def main():
                       dest="do_replace",
                       help="Replace previous running scheduler")
     parser.add_option('--debugfile', dest='debug_file',
-                      help=("Debug file. Default: not used "
-                            "(why debug a bug free program? :) )"))
+                      help=("Enable debug log and save it to a file. "
+                            "Default: not used"))
     parser.add_option("-p", "--profile",
                       dest="profile",
-                      help="Dump a profile file. Need the python cProfile librairy")
+                      help="Dump a profile file. Need the python cProfile library")
 
     opts, args = parser.parse_args()
     if args:

diff --git a/manpages/manpages/shinken-arbiter.8 b/manpages/manpages/shinken-arbiter.8
@@ -75,7 +75,7 @@ Show program\(aqs version number
 Enable debug logging to \fIDEBUGFILE\fP
 .TP
 .BI \-p \ PROFILE\fP,\fB \ \-\-profile\fB= PROFILE
-Dump a profile file. Need the python cProfile librairy
+Dump a profile file. Need the python cProfile library
 .TP
 .BI \-a \ ANALYSE\fP,\fB \ \-\-analyse\fB= ANALYSE
 Dump an analyse statistics file, for support

diff --git a/manpages/manpages/shinken-broker.8 b/manpages/manpages/shinken-broker.8
@@ -76,7 +76,7 @@ Show program\(aqs version number
 Enable debug logging to \fIDEBUGFILE\fP
 .TP
 .BI \-p \ PROFILE\fP,\fB \ \-\-profile\fB= PROFILE
-Dump a profile file. Need the python cProfile librairy
+Dump a profile file. Need the python cProfile library
 .UNINDENT
 .UNINDENT
 .UNINDENT

diff --git a/manpages/manpages/shinken-poller.8 b/manpages/manpages/shinken-poller.8
@@ -68,7 +68,7 @@ Show program\(aqs version number
 Enable debug logging to \fIDEBUGFILE\fP
 .TP
 .BI \-p \ PROFILE\fP,\fB \ \-\-profile\fB= PROFILE
-Dump a profile file. Need the python cProfile librairy
+Dump a profile file. Need the python cProfile library
 .UNINDENT
 .UNINDENT
 .UNINDENT

diff --git a/manpages/manpages/shinken-reactionner.8 b/manpages/manpages/shinken-reactionner.8
@@ -68,7 +68,7 @@ Show program\(aqs version number
 Enable debug logging to \fIDEBUGFILE\fP
 .TP
 .BI \-p \ PROFILE\fP,\fB \ \-\-profile\fB= PROFILE
-Dump a profile file. Need the python cProfile librairy
+Dump a profile file. Need the python cProfile library
 .UNINDENT
 .UNINDENT
 .UNINDENT

diff --git a/manpages/manpages/shinken-receiver.8 b/manpages/manpages/shinken-receiver.8
@@ -68,7 +68,7 @@ Show program\(aqs version number
 Enable debug logging to \fIDEBUGFILE\fP
 .TP
 .BI \-p \ PROFILE\fP,\fB \ \-\-profile\fB= PROFILE
-Dump a profile file. Need the python cProfile librairy
+Dump a profile file. Need the python cProfile library
 .UNINDENT
 .UNINDENT
 .UNINDENT

diff --git a/manpages/manpages/shinken-scheduler.8 b/manpages/manpages/shinken-scheduler.8
@@ -68,7 +68,7 @@ Show program\(aqs version number
 Enable debug logging to \fIDEBUGFILE\fP
 .TP
 .BI \-p \ PROFILE\fP,\fB \ \-\-profile\fB= PROFILE
-Dump a profile file. Need the python cProfile librairy
+Dump a profile file. Need the python cProfile library
 .UNINDENT
 .UNINDENT
 .UNINDENT

diff --git a/manpages/sources/shinken-arbiter.rst b/manpages/sources/shinken-arbiter.rst
@@ -46,7 +46,7 @@ OPTIONS
   -h, --help                                Show this help message
   --version                                 Show program's version number
   --debugfile=DEBUGFILE                     Enable debug logging to *DEBUGFILE*
-  -p PROFILE, --profile=PROFILE             Dump a profile file. Need the python cProfile librairy
+  -p PROFILE, --profile=PROFILE             Dump a profile file. Need the python cProfile library
   -a ANALYSE, --analyse=ANALYSE             Dump an analyse statistics file, for support
   -m MIGRATE, --migrate=MIGRATE             Migrate the raw configuration read from the arbiter to another module. --> VERY EXPERIMENTAL!
   -n ARB_NAME, --name=ARB_NAME              Give the arbiter name to use. Optionnal, will use the hostaddress if not provide to find it.

diff --git a/manpages/sources/shinken-broker.rst b/manpages/sources/shinken-broker.rst
@@ -45,5 +45,5 @@ OPTIONS
   -h, --help                                    Show this help message
   --version                                     Show program's version number 
   --debugfile=DEBUGFILE                         Enable debug logging to *DEBUGFILE*
-  -p PROFILE, --profile=PROFILE                 Dump a profile file. Need the python cProfile librairy
+  -p PROFILE, --profile=PROFILE                 Dump a profile file. Need the python cProfile library
 
diff --git a/manpages/sources/shinken-poller.rst b/manpages/sources/shinken-poller.rst
@@ -37,5 +37,5 @@ OPTIONS
   -h, --help                                    Show this help message
   --version                                     Show program's version number 
   --debugfile=DEBUGFILE                         Enable debug logging to *DEBUGFILE*
-  -p PROFILE, --profile=PROFILE                 Dump a profile file. Need the python cProfile librairy
+  -p PROFILE, --profile=PROFILE                 Dump a profile file. Need the python cProfile library
 
diff --git a/manpages/sources/shinken-reactionner.rst b/manpages/sources/shinken-reactionner.rst
@@ -37,5 +37,5 @@ OPTIONS
   -h, --help                                    Show this help message
   --version                                     Show program's version number 
   --debugfile=DEBUGFILE                         Enable debug logging to *DEBUGFILE*
-  -p PROFILE, --profile=PROFILE                 Dump a profile file. Need the python cProfile librairy
+  -p PROFILE, --profile=PROFILE                 Dump a profile file. Need the python cProfile library
 
diff --git a/manpages/sources/shinken-receiver.rst b/manpages/sources/shinken-receiver.rst
@@ -37,5 +37,5 @@ OPTIONS
   -h, --help                                    Show this help message
   --version                                     Show program's version number 
   --debugfile=DEBUGFILE                         Enable debug logging to *DEBUGFILE*
-  -p PROFILE, --profile=PROFILE                 Dump a profile file. Need the python cProfile librairy
+  -p PROFILE, --profile=PROFILE                 Dump a profile file. Need the python cProfile library
 
diff --git a/manpages/sources/shinken-scheduler.rst b/manpages/sources/shinken-scheduler.rst
@@ -37,5 +37,5 @@ OPTIONS
   -h, --help                                    Show this help message
   --version                                     Show program's version number 
   --debugfile=DEBUGFILE                         Enable debug logging to *DEBUGFILE*
-  -p PROFILE, --profile=PROFILE                 Dump a profile file. Need the python cProfile librairy
+  -p PROFILE, --profile=PROFILE                 Dump a profile file. Need the python cProfile library
 
diff --git a/shinken/http_daemon.py b/shinken/http_daemon.py
@@ -173,9 +173,9 @@ def log_request(*args, **kw):
 
         if use_ssl:
             if not ssl:
-                logger.error("Missing python-openssl librairy,"
+                logger.error("Missing python-openssl library,"
                              "please install it to open a https backend")
-                raise Exception("Missing python-openssl librairy, "
+                raise Exception("Missing python-openssl library, "
                                 "please install it to open a https backend")
             srv.socket = ssl.wrap_socket(srv.socket,
                                          keyfile=ssl_key, certfile=ssl_cert, server_side=True)