# HG changeset patch
# User Franz Glasner <fzglas.hg@dom66.de>
# Date 1569397444 -7200
# Node ID bf8f0aa3c698625a57a68c46b8487bf3f3456111
# Parent  a9324638b70e68d24db5b1a87a8ef5f1fb4628d0
Docu: get_mapping() is documented now

diff -r a9324638b70e -r bf8f0aa3c698 bin/check-ports
--- a/bin/check-ports	Wed Sep 25 09:43:46 2019 +0200
+++ b/bin/check-ports	Wed Sep 25 09:44:04 2019 +0200
@@ -257,6 +257,30 @@
 }
 
 get_mapping() {
+    : 'Determine whether a package `_package` is essentially the same as
+    another package.
+
+    Args:
+        _package: the new name of the package
+
+    Returns:
+        0 when a package mapping has been found, 1 otherwise
+
+    Output (Globals):
+        mapped_package_name: the name of the package on which `_package` is
+                             based on
+
+    This command reads from the mapping database in in file
+    `/usr/local/etc/local-bsdtools/package-mapping.conf`.
+    Example::
+
+        #
+        # _package                         mapped_package_name
+        #
+        fmg-nextcloud-php71                nextcloud-php71
+        fmg-nextcloud-twofactor_totp-php71 nextcloud-twofactor_totp-php71
+
+    '
     local _package _n _mapped
 
     _package=$1