location.txt: Improve manpage

Message ID 4b962407-f8c8-6419-140e-121d5f17ee81@ipfire.org
State Accepted
Commit f55a43e85103003ef85cb13c20755caf8867cc5d
Headers
Series location.txt: Improve manpage |

Commit Message

Peter Müller Oct. 10, 2021, 4:45 p.m. UTC
  * Document "location version" feature.
* Improve section for reporting bugs in order to make bug reporting
  easier.

Fixes: #12698

Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
---
 man/location.txt | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
  

Comments

Michael Tremer Oct. 11, 2021, 11:23 a.m. UTC | #1
Thank you.

-Michael

> On 10 Oct 2021, at 17:45, Peter Müller <peter.mueller@ipfire.org> wrote:
> 
> * Document "location version" feature.
> * Improve section for reporting bugs in order to make bug reporting
>  easier.
> 
> Fixes: #12698
> 
> Signed-off-by: Peter Müller <peter.mueller@ipfire.org>
> ---
> man/location.txt | 9 +++++++--
> 1 file changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/man/location.txt b/man/location.txt
> index 3878cb8..c3abff1 100644
> --- a/man/location.txt
> +++ b/man/location.txt
> @@ -15,6 +15,7 @@ location - Query the location database
> `location search-as STRING`
> `location update [--cron=daily|weekly|monthly]`
> `location verify`
> +`location version`
> 
> == DESCRIPTION
> `location` retrieves information from the location database.
> @@ -106,6 +107,9 @@ or countries.
> 'verify'::
> 	Verifies the downloaded database.
> 
> +'version'::
> +	Shows the version information of the downloaded database.
> +
> '--help'::
> 	Shows a short help text on using this program.
> 
> @@ -134,8 +138,9 @@ It will then try to download a file with that version from a mirror server.
> If the downloaded file is outdated, the next mirror will be tried until we
> have found a file that is recent enough.
> 
> -== BUGS
> -Please report all bugs to the bugtracker at https://bugzilla.ipfire.org/.
> +== BUG REPORTS
> +Please report all bugs to the bugtracker at https://bugzilla.ipfire.org/;
> +refer to https://wiki.ipfire.org/devel/bugzilla for details.
> 
> == AUTHORS
> Michael Tremer
> -- 
> 2.26.2
  

Patch

diff --git a/man/location.txt b/man/location.txt
index 3878cb8..c3abff1 100644
--- a/man/location.txt
+++ b/man/location.txt
@@ -15,6 +15,7 @@  location - Query the location database
 `location search-as STRING`
 `location update [--cron=daily|weekly|monthly]`
 `location verify`
+`location version`
 
 == DESCRIPTION
 `location` retrieves information from the location database.
@@ -106,6 +107,9 @@  or countries.
 'verify'::
 	Verifies the downloaded database.
 
+'version'::
+	Shows the version information of the downloaded database.
+
 '--help'::
 	Shows a short help text on using this program.
 
@@ -134,8 +138,9 @@  It will then try to download a file with that version from a mirror server.
 If the downloaded file is outdated, the next mirror will be tried until we
 have found a file that is recent enough.
 
-== BUGS
-Please report all bugs to the bugtracker at https://bugzilla.ipfire.org/.
+== BUG REPORTS
+Please report all bugs to the bugtracker at https://bugzilla.ipfire.org/;
+refer to https://wiki.ipfire.org/devel/bugzilla for details.
 
 == AUTHORS
 Michael Tremer