changeset 712:6501f942f271

Man for package-mapping.conf: FIX: Order of fields was documented wrongly. While there: also enhance the wording of some paragraphs.
author Franz Glasner <fzglas.hg@dom66.de>
date Thu, 03 Oct 2024 19:52:23 +0200
parents c14d454a7918
children 31023b6bf315
files docs/man/man5/package-mapping.conf.rst
diffstat 1 files changed, 11 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/docs/man/man5/package-mapping.conf.rst	Wed Oct 02 22:00:49 2024 +0200
+++ b/docs/man/man5/package-mapping.conf.rst	Thu Oct 03 19:52:23 2024 +0200
@@ -8,27 +8,28 @@
 
 Used by :manpage:`check-ports(8)`.
 
-This is a textfile where every line contains two words -- each being
-a package names::
+This is a textfile where every line contains two fields -- separated by
+white space (TAB or SPACE). Each field is a package name::
 
-    package-name  mapped-package-name
+    installed-package-name  original-package-name
 
 When :command:`check-ports` determines the package status for
-`mapped-package-name` then the repositories are checked with regard to
-`package-name` also.
+`installed-package-name` then the repositories are checked with regard to
+`original-package-name` also.
 
-This is useful when the update status of renamed (private) forks should be
-checked against the original parent package also.
+This is useful when the update status of renamed (private) forks (with
+`installed-package-name`) should be checked against the original
+parent package (with name `original-package-name`) also.
 
 
 Examples
 --------
 
 Assume that package ``pack-orig`` is forked into a local package with
-a different name ``my-forked-pack``. To let the :command:`check-ports` tool
-to take this into account use::
+a different name ``my-forked-pack``. To let the tools :command:`check-ports`
+and :command:`fports` to take this into account use::
 
-    pack-orig my-forked-pack
+    my-forked-pack pack-orig
 
 
 See Also