[pmg-devel] [PATCH docs] useful cli tools: fix typos and grammar

Stoiko Ivanov s.ivanov at proxmox.com
Thu Apr 23 12:02:53 CEST 2020


Thanks!

LGTM.
Reviewed-By: Stoiko Ivanov <s.ivanov at proxmox.com>

On Thu, 23 Apr 2020 11:00:13 +0200
Oguz Bektas <o.bektas at proxmox.com> wrote:

> Signed-off-by: Oguz Bektas <o.bektas at proxmox.com>
> ---
>  nmap.adoc            | 9 +++++----
>  pmgdb.adoc           | 4 ++--
>  pmgperf.adoc         | 4 ++--
>  pmgreport.adoc       | 2 +-
>  pmgsubscription.adoc | 4 ++--
>  pmgupgrade.adoc      | 4 ++--
>  pmgversion.adoc      | 4 ++--
>  7 files changed, 16 insertions(+), 15 deletions(-)
> 
> diff --git a/nmap.adoc b/nmap.adoc
> index 3141253..1a06b79 100644
> --- a/nmap.adoc
> +++ b/nmap.adoc
> @@ -3,8 +3,8 @@
>  -------------------
>  
>  `nmap` is designed to allow system administrators to scan large
> -networks to determine which hosts are up and what services they are
> -offering. You can use nmap to test your firewall setting, for example
> +networks to determine which hosts are up and what services they
> +offer. You can use nmap to test your firewall settings, for example
>  to see if the required ports are open.
>  
>  .Test Razor port (tcp port 2703):
> @@ -20,5 +20,6 @@ PORT     STATE SERVICE
>  Nmap done: 1 IP address (1 host up) scanned in 6.83 seconds
>  ----
>  
> -See the https://nmap.org/book/man.html[Nmap Reference Guide], also available as
> -manual page (`man nmap`), for more information about nmap.
> +For more information about `nmap` usage, see the
> +https://nmap.org/book/man.html[Nmap Reference Guide], also available as a manual
> +page (`man nmap`).
> diff --git a/pmgdb.adoc b/pmgdb.adoc
> index 385149f..60f6a76 100644
> --- a/pmgdb.adoc
> +++ b/pmgdb.adoc
> @@ -26,7 +26,7 @@ pmgdb - Database Management Toolkit
>  endif::manvolnum[]
>  
>  The `pmgdb` toolkit is used to simplify common database management
> -tasks. Most important, it is used internally to create and initialize
> +tasks. Most importantly, it is used internally to create and initialize
>  the default database. You can also use it to reset the filter rules
>  back to factory defaults:
>  
> @@ -34,7 +34,7 @@ back to factory defaults:
>  pmgdb reset
>  ----
>  
> -Or you can dump a human readable copy of the filter rules:
> +Or you can dump a human-readable copy of the filter rules:
>  
>  ----
>  pmgdb dump
> diff --git a/pmgperf.adoc b/pmgperf.adoc
> index 24b6930..8cfcd8d 100644
> --- a/pmgperf.adoc
> +++ b/pmgperf.adoc
> @@ -25,8 +25,8 @@ pmgperf - Proxmox Simple Performance Benchmark
>  :pmg-toplevel:
>  endif::manvolnum[]
>  
> -The command line tool `pmgperf` tries to gather some general
> -performance data. This is mostly useful for debugging and to identify
> +The command line tool `pmgperf` gathers some general
> +performance data. This is mostly useful for debugging and identifying
>  performance bottlenecks. It computes the following metrics:
>  
>  [horizontal]
> diff --git a/pmgreport.adoc b/pmgreport.adoc
> index ae30625..59c676d 100644
> --- a/pmgreport.adoc
> +++ b/pmgreport.adoc
> @@ -25,7 +25,7 @@ pmgreport - Send daily system report email
>  :pmg-toplevel:
>  endif::manvolnum[]
>  
> -This binary generates and send daily system report email.
> +Generates and send daily system report email.
>  
>  ifdef::manvolnum[]
>  include::pmg-copyright.adoc[]
> diff --git a/pmgsubscription.adoc b/pmgsubscription.adoc
> index 792beb4..9005853 100644
> --- a/pmgsubscription.adoc
> +++ b/pmgsubscription.adoc
> @@ -23,9 +23,9 @@ pmgsubscription - Subscription Management
>  =========================================
>  endif::manvolnum[]
>  
> -{pmg} is free open software, and the company that developed it
> +{pmg} is free and open-source software, and the company that develops it
>  (Proxmox Server Solutions GmbH) offers {pricing-url}[support] in many
> -ways, with different support channel, level and pricing.
> +ways, with different support channels, levels and pricing.
>  
>  The tool `pmgsubscription` is used to handle {pmg}
>  subscriptions. Please use the GUI or the `set` command to upload a new
> diff --git a/pmgupgrade.adoc b/pmgupgrade.adoc
> index ebdd73e..7f736b9 100644
> --- a/pmgupgrade.adoc
> +++ b/pmgupgrade.adoc
> @@ -26,10 +26,10 @@ endif::manvolnum[]
>  
>  This is a small wrapper around `apt-get dist-upgrade`. We use this to
>  print additional information (kernel restart required?), and
> -optionally run an interactive shell after the update. This binary is
> +optionally run an interactive shell after the update. It is
>  invoked when starting an upgrade using the web GUI.
>  
> -If you are already logged in on the console, it is peferable to invoke
> +If you are already logged in on the console, it is preferable to invoke
>  `apt-get` directly.
>  
>  ----
> diff --git a/pmgversion.adoc b/pmgversion.adoc
> index 8ceb397..9f86e7f 100644
> --- a/pmgversion.adoc
> +++ b/pmgversion.adoc
> @@ -24,7 +24,7 @@ pmgversion - Version Info
>  :pmg-toplevel:
>  endif::manvolnum[]
>  
> -The binary `pmgversion` prints detailed version information for {pmg}
> +`pmgversion` prints detailed version information for {pmg}
>  packages.
>  
>  .Examples
> @@ -35,7 +35,7 @@ Print {pmg} version:
>  # pmgversion
>  ----
>  
> -List version details for important packages: 
> +List version details for important packages:
>  
>  ----
>  # pmgversion -v




More information about the pmg-devel mailing list