[X2Go-Commits] [x2goserver] 77/99: X2Go/Server/Agent/NX/Options.pm: document that subroutines and constants that are not marked for export are internal and should not be used.

git-admin at x2go.org git-admin at x2go.org
Mon Dec 28 06:10:51 CET 2020


This is an automated email from the git hooks/post-receive script.

x2go pushed a commit to branch master
in repository x2goserver.

commit 03840dc1cef1f5f33e2252e9589af3318168e211
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Sun Nov 29 08:23:02 2020 +0100

    X2Go/Server/Agent/NX/Options.pm: document that subroutines and constants that are not marked for export are internal and should not be used.
    
    Usually, that should implicitly be clear, but it doesn't hurt to be
    verbose with a disclaimer.
---
 X2Go/Server/Agent/NX/Options.pm | 5 +++++
 debian/changelog                | 4 ++++
 2 files changed, 9 insertions(+)

diff --git a/X2Go/Server/Agent/NX/Options.pm b/X2Go/Server/Agent/NX/Options.pm
index af165bfe..5b0ac0fe 100644
--- a/X2Go/Server/Agent/NX/Options.pm
+++ b/X2Go/Server/Agent/NX/Options.pm
@@ -940,6 +940,11 @@ identical to the original options string (assuming no errors occurred).
 
 If this is not the case, please report a bug.
 
+Any subroutines and constants not marked as exportable are
+B<explicitly not documented> and should be regarded as internal and
+B<not be used>.
+There is B<no> guarantee regarding their behavior or existence.
+
 =head1 OPTIONS STRINGS
 
 B<X2Go/NX Agent> options strings are fully documented in
diff --git a/debian/changelog b/debian/changelog
index a7b01e0f..6741b45a 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -342,6 +342,10 @@ x2goserver (4.1.0.4-0x2go1.2) UNRELEASED; urgency=medium
       intermediate checking out into a separate subroutine.
     - X2Go/Server/Agent/NX/Options.pm: rename $options variable to
       $intermediate in intermediate_to_string () for internal consistency.
+    - X2Go/Server/Agent/NX/Options.pm: document that subroutines and constants
+      that are not marked for export are internal and should not be used.
+      Usually, that should implicitly be clear, but it doesn't hurt to be
+      verbose with a disclaimer.
   * debian/control:
     + Build-depend upon lsb-release for distro version detection.
   * debian/x2goserver.manpages:

--
Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/x2goserver.git


More information about the x2go-commits mailing list