[X2Go-Commits] [x2goserver] 22/30: x2goserver/lib/x2goupdateoptionsstring: update documentation and clarify risks of option parsing.

[git-admin at x2go.org]

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

x2go pushed a commit to branch master
in repository x2goserver.

commit b74def088c12188ef1e632c6cdaa78af76147f9f
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Wed Dec 12 10:19:49 2018 +0100

    x2goserver/lib/x2goupdateoptionsstring: update documentation and clarify risks of option parsing.
    
    It's better to always use -- to terminate program options parsing when
    no longer needed.
---
 debian/changelog                       | 3 +++
 x2goserver/lib/x2goupdateoptionsstring | 5 +++++
 2 files changed, 8 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index 613fcb1..f6909d5 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -52,6 +52,9 @@ x2goserver (4.1.0.4-0x2go1) UNRELEASED; urgency=medium
     - x2goserver/lib/x2goupdateoptionsstring: add debug option and some
       debugging output.
     - x2goserver/lib/x2goupdateoptionsstring: remove dead code.
+    - x2goserver/lib/x2goupdateoptionsstring: update documentation and clarify
+      risks of option parsing. It's better to always use -- to terminate
+      program options parsing when no longer needed.
   * debian/control:
     + Build-depend upon lsb-release for distro version detection.
   * debian/x2goserver.manpages:
diff --git a/x2goserver/lib/x2goupdateoptionsstring b/x2goserver/lib/x2goupdateoptionsstring
index 1dcab20..6e304e8 100755
--- a/x2goserver/lib/x2goupdateoptionsstring
+++ b/x2goserver/lib/x2goupdateoptionsstring
@@ -822,6 +822,11 @@ different value, the component will be replaced with the provided value.
 To fully remove a component, pass B<->I<key>. To only remove it if it is set to
 a specific value, pass B<->I<key>B<=>I<value>.
 
+You can terminate program options parsing via a standard double-dash (B<-->)
+pseudo-option. It is recommended to always do so if you pass removal
+transformation operations, even if no actual options are used to avoid
+misinterpreting such transformation options as options/flags to the program.
+
 =head1 OPTIONS
 
 =over 8

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