From 30354d623ec55b20b2a9908aadef2f10f65d2db1 Mon Sep 17 00:00:00 2001 From: Georgiy Timchenko Date: Sun, 10 Dec 2023 14:02:43 +0400 Subject: Fix typos in project documentation Several typos were found and corrected in the project documentation. These changes affect the following files: - docs/cmds.rst - docs/config.rst These corrections improve the readability and accuracy of the documentation, making it more accessible and understandable for users and developers. --- docs/cmds.rst | 6 +++--- docs/config.rst | 13 +++++++------ 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/cmds.rst b/docs/cmds.rst index cffeb153..06a2187d 100644 --- a/docs/cmds.rst +++ b/docs/cmds.rst @@ -22,7 +22,7 @@ Command-Line Options path to the configuration file -.. option:: -P plugin directory, --plugins plugin directory +.. option:: -P PLUGIN_DIRECTORY, --plugins PLUGIN_DIRECTORY path to a directory containing additional plugins @@ -224,7 +224,7 @@ Command-Line Options .. option:: --disable-check-update - disable online Glances version ckeck + disable online Glances version check Interactive Commands -------------------- @@ -305,7 +305,7 @@ The following commands (key pressed) are supported while in Glances: Increase selected process nice level / Lower the priority (need right) - Only in standalone mode. ``-`` - Decrease selected process nice level / Higher the priority (need right) - Only in standalone mode. + Decrease selected process nice level / Higher the priority (need right) - Only in standalone mode. ``k`` Kill selected process (need right) - Only in standalone mode. diff --git a/docs/config.rst b/docs/config.rst index f1c76e16..8aa3250e 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -40,10 +40,10 @@ A first section (called global) is available: [global] # Refresh rate (default is a minimum of 2 seconds) - # Can be overwrite by the -t option + # Can be overwritten by the -t option # It is also possible to overwrite it in each plugin sections refresh=2 - # Does Glances should check if a newer version is available on PyPI ? + # Should Glances check if a newer version is available on PyPI ? check_update=false # History size (maximum number of values) # Default is 28800: 1 day with 1 point every 3 seconds @@ -124,13 +124,14 @@ Logging Glances logs all of its internal messages to a log file. -``DEBUG`` messages can been logged using the ``-d`` option on the command +``DEBUG`` messages can be logged using the ``-d`` option on the command line. -The location of the Glances depends of your operating system. You could -displayed the Glances log file full path using the``glances -V`` command line. +The location of the Glances log file depends of your operating system. You can +display the full path of the Glances log file full path using the``glances -V`` +command line. -The file is automatically rotate when the size is higher than 1 MB. +The file is automatically rotated when its size exceeds 1 MB. If you want to use another system path or change the log message, you can use your own logger configuration. First of all, you have to create -- cgit v1.2.3