[X2Go-Commits] [python-x2go] 02/02: Fix various hrefs in __doc__ strings.
git-admin at x2go.org
git-admin at x2go.org
Tue Oct 14 21:36:51 CEST 2014
This is an automated email from the git hooks/post-receive script.
x2go pushed a commit to branch master
in repository python-x2go.
commit 191b92e4b422f95fe3817e4b60649c418910cc65
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date: Tue Oct 14 21:36:42 2014 +0200
Fix various hrefs in __doc__ strings.
---
debian/changelog | 1 +
x2go/backends/control/plain.py | 8 ++++----
x2go/backends/info/plain.py | 8 ++++++--
x2go/backends/printing/file.py | 4 ++--
x2go/backends/printing/gconf.py | 8 ++++----
x2go/backends/printing/winreg.py | 10 +++++-----
x2go/backends/profiles/base.py | 6 +++---
x2go/backends/profiles/file.py | 2 +-
x2go/backends/profiles/gconf.py | 2 +-
x2go/backends/profiles/sshbroker.py | 2 +-
x2go/backends/proxy/base.py | 10 +++++-----
x2go/backends/proxy/nx3.py | 4 ++--
x2go/backends/terminal/plain.py | 18 +++++++++---------
x2go/telekinesis.py | 2 +-
14 files changed, 45 insertions(+), 40 deletions(-)
diff --git a/debian/changelog b/debian/changelog
index 7942e26..4f99d27 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -113,6 +113,7 @@ python-x2go (0.5.0.0-0x2go1) UNRELEASED; urgency=low
- If the listsessions command detects a terminated or suspended session,
we have to destroy the corresponding X2GoTerminalSession() to trigger
a proper cleanup of that instance.
+ - Fix various hrefs in __doc__ strings.
* debian/control:
+ Add dependencies: python-requests, python-simplejson.
+ Add R (python-x2go): sshfs.
diff --git a/x2go/backends/control/plain.py b/x2go/backends/control/plain.py
index 093d5c6..6f3b0f8 100644
--- a/x2go/backends/control/plain.py
+++ b/x2go/backends/control/plain.py
@@ -164,7 +164,7 @@ class X2GoControlSession(paramiko.SSHClient):
are rendered without submenus
@type published_applications_no_submenus: C{int}
@param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoControlSessionSTDOUT} constructor
+ L{X2GoControlSession} constructor
@type logger: L{X2GoLogger} instance
@param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
constructed with the given loglevel
@@ -828,7 +828,7 @@ class X2GoControlSession(paramiko.SSHClient):
@param force_password_auth: non-paramiko option, disable pub/priv key authentication
completely, even if the C{pkey} or the C{key_filename} parameter is given
@type force_password_auth: C{bool}
- @param session_instance: an instance L{X2GoSession} using this L{X2GoControlSessionSTDOUT}
+ @param session_instance: an instance L{X2GoSession} using this L{X2GoControlSession}
instance.
@type session_instance: C{obj}
@param use_sshproxy: connect through an SSH proxy
@@ -1468,7 +1468,7 @@ class X2GoControlSession(paramiko.SSHClient):
"""\
Start a new X2Go session.
- The L{X2GoControlSessionSTDOUT.start()} method accepts any parameter
+ The L{X2GoControlSession.start()} method accepts any parameter
that can be passed to any of the C{X2GoTerminalSession} backend class
constructors.
@@ -1490,7 +1490,7 @@ class X2GoControlSession(paramiko.SSHClient):
"""\
Resume a running/suspended X2Go session.
- The L{X2GoControlSessionSTDOUT.resume()} method accepts any parameter
+ The L{X2GoControlSession.resume()} method accepts any parameter
that can be passed to any of the C{X2GoTerminalSession*} backend class constructors.
@return: True if the session could be successfully resumed
diff --git a/x2go/backends/info/plain.py b/x2go/backends/info/plain.py
index 96ef648..90f9f4d 100644
--- a/x2go/backends/info/plain.py
+++ b/x2go/backends/info/plain.py
@@ -296,8 +296,12 @@ class X2GoServerSessionInfo(object):
if _new != _current:
setattr(self, prop, _new)
- __init__ = clear
- """ Class constructor, identical to L{clear()} method. """
+ def __init__(self):
+ """\
+ Class constructor, identical to L{clear()} method.
+
+ """
+ self.clear()
class X2GoServerSessionList(object):
diff --git a/x2go/backends/printing/file.py b/x2go/backends/printing/file.py
index 1747ef6..4268e61 100644
--- a/x2go/backends/printing/file.py
+++ b/x2go/backends/printing/file.py
@@ -60,11 +60,11 @@ _print_property_map = {
class X2GoClientPrinting(inifiles.X2GoIniFile):
"""\
- L{X2GoClientPrinting} provides access to the X2Go ini-like file
+ L{x2go.backends.printing.file.X2GoClientPrinting} provides access to the X2Go ini-like file
»printing« as stored in C{~/.x2goclient/printing} resp. globally
C{/etc/x2goclient/printing}.
- An instance of L{X2GoClientPrinting} is created on each incoming
+ An instance of L{x2go.backends.printing.file.X2GoClientPrinting} is created on each incoming
print job. This facilitates that on every print job the print action
for this job is derived from the »printing« configuration file.
diff --git a/x2go/backends/printing/gconf.py b/x2go/backends/printing/gconf.py
index 75bdaf3..3741c3e 100644
--- a/x2go/backends/printing/gconf.py
+++ b/x2go/backends/printing/gconf.py
@@ -40,12 +40,12 @@ from x2go.x2go_exceptions import X2GoNotImplementedYetException
class X2GoClientPrinting(object):
"""\
- L{X2GoClientPrintingGCONF} provides access to the GCONF based configuration
+ L{x2go.backends.printing.gconf.X2GoClientPrinting} provides access to the GCONF based configuration
of the X2Go client printing setup.
- An instance of L{X2GoClientPrintingGCONF} is created on each incoming
- print job. This facilitates that on every print job the print action
- for this job is derived from the »printing« configuration file.
+ An instance of L{x2go.backends.printing.gconf.X2GoClientPrinting} is created on each incoming
+ print job. This facilitates that on every print job the print action for this job is derived
+ from the »printing« configuration file.
Thus, changes on the file are active for the next incoming print job.
diff --git a/x2go/backends/printing/winreg.py b/x2go/backends/printing/winreg.py
index a730e74..d0fb75d 100644
--- a/x2go/backends/printing/winreg.py
+++ b/x2go/backends/printing/winreg.py
@@ -40,12 +40,12 @@ from x2go.x2go_exceptions import X2GoNotImplementedYetException
class X2GoClientPrinting(object):
"""\
- L{X2GoClientPrinting} provides access to the Windows registry based configuration
- of the X2Go client printing setup.
+ L{x2go.backends.printing.winreg.X2GoClientPrinting} provides access to the Windows registry
+ based configuration of the X2Go client printing setup.
- An instance of L{X2GoClientPrintingWINREG} is created on each incoming
- print job. This facilitates that on every print job the print action
- for this job is derived from the »printing« configuration file.
+ An instance of L{x2go.backends.printing.winreg.X2GoClientPrinting} is created on each incoming
+ print job. This facilitates that on every print job the print action for this job is derived from the
+ »printing« configuration file.
Thus, changes on the file are active for the next incoming print job.
diff --git a/x2go/backends/profiles/base.py b/x2go/backends/profiles/base.py
index 7310518..3a42452 100644
--- a/x2go/backends/profiles/base.py
+++ b/x2go/backends/profiles/base.py
@@ -51,7 +51,7 @@ class X2GoSessionProfiles():
@param session_profile_defaults: a default session profile
@type session_profile_defaults: C{dict}
@param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoSessionProfilesHTTPSBROKER} constructor
+ L{x2go.backends.profiles.httpbroker.X2GoSessionProfiles} constructor
@type logger: L{X2GoLogger} instance
@param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
constructed with the given loglevel
@@ -239,7 +239,7 @@ class X2GoSessionProfiles():
mutable session profiles.
@return: list of mutable profiles
- @rtype: C{list)
+ @rtype: C{list}
"""
return self._supports_mutable_profiles()
@@ -251,7 +251,7 @@ class X2GoSessionProfiles():
session profiles or not.
@return: list of mutable profiles
- @rtype: C{list)
+ @rtype: C{list}
"""
return False
diff --git a/x2go/backends/profiles/file.py b/x2go/backends/profiles/file.py
index 913267d..ee4debf 100644
--- a/x2go/backends/profiles/file.py
+++ b/x2go/backends/profiles/file.py
@@ -46,7 +46,7 @@ class X2GoSessionProfiles(base.X2GoSessionProfiles, inifiles.X2GoIniFile):
@param session_profile_defaults: a default session profile
@type session_profile_defaults: C{dict}
@param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoSessionProfilesFILE} constructor
+ L{x2go.backends.profiles.file.X2GoSessionProfiles} constructor
@type logger: L{X2GoLogger} instance
@param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
constructed with the given loglevel
diff --git a/x2go/backends/profiles/gconf.py b/x2go/backends/profiles/gconf.py
index cf2ef86..3c3089f 100644
--- a/x2go/backends/profiles/gconf.py
+++ b/x2go/backends/profiles/gconf.py
@@ -45,7 +45,7 @@ class X2GoSessionProfiles(base.X2GoSessionProfiles):
@param session_profile_defaults: a default session profile
@type session_profile_defaults: C{dict}
@param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoSessionProfilesGCONF} constructor
+ L{x2go.backends.profiles.gconf.X2GoSessionProfiles} constructor
@type logger: L{X2GoLogger} instance
@param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
constructed with the given loglevel
diff --git a/x2go/backends/profiles/sshbroker.py b/x2go/backends/profiles/sshbroker.py
index 32bc8c3..d5e8b70 100644
--- a/x2go/backends/profiles/sshbroker.py
+++ b/x2go/backends/profiles/sshbroker.py
@@ -46,7 +46,7 @@ class X2GoSessionProfiles(base.X2GoSessionProfiles):
@param session_profile_defaults: a default session profile
@type session_profile_defaults: C{dict}
@param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoSessionProfilesHTTPSBROKER} constructor
+ L{x2go.backends.profiles.httpbroker.X2GoSessionProfiles} constructor
@type logger: L{X2GoLogger} instance
@param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
constructed with the given loglevel
diff --git a/x2go/backends/proxy/base.py b/x2go/backends/proxy/base.py
index 2515525..6e24548 100644
--- a/x2go/backends/proxy/base.py
+++ b/x2go/backends/proxy/base.py
@@ -52,7 +52,7 @@ class X2GoProxy(threading.Thread):
X2GoProxy is an abstract class for X2Go proxy connections.
This class needs to be inherited from a concrete proxy class. Only
- currently available proxy class is: L{X2GoProxyNX3}.
+ currently available proxy class is: L{x2go.backends.proxy.nx3.X2GoProxy}.
"""
PROXY_CMD = ''
@@ -84,12 +84,12 @@ class X2GoProxy(threading.Thread):
@type session_log: C{str}
@param sessions_rootdir: base dir where X2Go session files are stored (by default: ~/.x2go)
@type sessions_rootdir: C{str}
- @param proxy_options: a set of very C{X2GoProxy*} backend specific options; any option that is not known
- to the C{X2GoProxy*} backend will simply be ignored
+ @param proxy_options: a set of very L{base.X2GoProxy} backend specific options; any option that is not known
+ to the L{base.X2GoProxy} backend will simply be ignored
@type proxy_options: C{dict}
@param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoProxy} constructor
- @param session_instance: the L{X2GoSession} instance this C{X2GoProxy*} instance belongs to
+ L{base.X2GoProxy} constructor
+ @param session_instance: the L{X2GoSession} instance this L{base.X2GoProxy} instance belongs to
@type session_instance: L{X2GoSession} instance
@type logger: L{X2GoLogger} instance
@param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
diff --git a/x2go/backends/proxy/nx3.py b/x2go/backends/proxy/nx3.py
index e15d764..1d0a4cf 100644
--- a/x2go/backends/proxy/nx3.py
+++ b/x2go/backends/proxy/nx3.py
@@ -36,13 +36,13 @@ class X2GoProxy(base.X2GoProxy):
"""\
This L{X2GoProxy} class is a NX version 3 based X2Go proxy connection class.
- It basically fills L{x2go.backends.proxy.X2GoProxy} variables with sensible content. Its
+ It basically fills L{x2go.backends.proxy.base.X2GoProxy} variables with sensible content. Its
methods mostly wrap around the corresponding methods of the parent class.
"""
def __init__(self, *args, **kwargs):
"""\
- For available parameters refer to L{X2GoProxyBASE} class documentation.
+ For available parameters refer to L{x2go.backends.proxy.base.X2GoProxy} class documentation.
"""
base.X2GoProxy.__init__(self, *args, **kwargs)
diff --git a/x2go/backends/terminal/plain.py b/x2go/backends/terminal/plain.py
index 7c10c64..c902f02 100644
--- a/x2go/backends/terminal/plain.py
+++ b/x2go/backends/terminal/plain.py
@@ -185,11 +185,11 @@ class X2GoTerminalSession(object):
"""\
Class for managing X2Go terminal sessions on a remote X2Go server via Paramiko/SSH.
- With the L{X2GoTerminalSessionSTDOUT} class you can start new X2Go sessions, resume suspended
+ With the L{x2go.backends.terminal.plain.X2GoTerminalSession} class you can start new X2Go sessions, resume suspended
sessions or suspend resp. terminate currently running sessions on a
connected X2Go server.
- An L{X2GoTerminalSessionSTDOUT} object uses two main data structure classes:
+ An L{x2go.backends.terminal.plain.X2GoTerminalSession} object uses two main data structure classes:
- L{X2GoSessionParams}: stores all parameters that have been passed to the
constructor method.
@@ -198,7 +198,7 @@ class X2GoTerminalSession(object):
will be used to store all information retrieved from the X2Go server.
The terminal session instance works closely together (i.e. depends on) a connected control
- session instance (e.g. L{X2GoControlSessionSTDOUT}). You never should use either of them as a standalone
+ session instance (e.g. L{x2go.backends.control.plain.X2GoControlSession}). You never should use either of them as a standalone
instance. Both, control session and terminal session(s) get managed/controlled via L{X2GoSession} instances.
"""
@@ -225,7 +225,7 @@ class X2GoTerminalSession(object):
session_instance=None,
logger=None, loglevel=log.loglevel_DEFAULT):
"""\
- Initialize an X2Go session. With the L{X2GoTerminalSessionSTDOUT} class you can start
+ Initialize an X2Go session. With the L{x2go.backends.terminal.plain.X2GoTerminalSession} class you can start
new X2Go sessions, resume suspended sessions or suspend resp. terminate
currently running sessions on a connected X2Go server.
@@ -240,7 +240,7 @@ class X2GoTerminalSession(object):
@type pack: C{str}
@param dpi: dots-per-inch value for the session screen (has an impact on the font size on screen)
@type dpi: C{str}
- @param cache_type: a dummy parameter that is passed to the L{X2GoProxyBASE}. In NX Proxy
+ @param cache_type: a dummy parameter that is passed to the L{x2go.backends.proxy.base.X2GoProxy}. In NX Proxy
(class C{X2GoProxyNX3}) this originally is the session name. With X2Go it
defines the name of the NX cache directory. Best is to leave it untouched.
@type cache_type: C{str}
@@ -261,7 +261,7 @@ class X2GoTerminalSession(object):
@param snd_port: local sound port for network capable audio system
@type snd_port: C{int}
@param cmd: command to be run on X2Go server after session start (only used
- when L{X2GoTerminalSessionSTDOUT.start()} is called, ignored on resume, suspend etc.
+ when L{x2go.backends.terminal.plain.X2GoTerminalSession.start()} is called, ignored on resume, suspend etc.
@type cmd: C{str}
@param published_applications: session is published applications provider
@type published_applications: C{bool}
@@ -311,7 +311,7 @@ class X2GoTerminalSession(object):
@param session_instance: the L{X2GoSession} instance that is parent to this terminal session
@type session_instance: C{obj}
@param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoTerminalSessionSTDOUT} constructor
+ L{x2go.backends.terminal.plain.X2GoTerminalSession} constructor
@type logger: L{X2GoLogger} instance
@param loglevel: if no L{X2GoLogger} object has been supplied a new one will be
constructed with the given loglevel
@@ -1237,8 +1237,8 @@ class X2GoTerminalSession(object):
"""\
Run a command in this session.
- After L{X2GoTerminalSessionSTDOUT.start()} has been called
- one or more commands can be executed with L{X2GoTerminalSessionSTDOUT.run_command()}
+ After L{x2go.backends.terminal.plain.X2GoTerminalSession.start()} has been called
+ one or more commands can be executed with L{x2go.backends.terminal.plain.X2GoTerminalSession.run_command()}
within the current X2Go session.
@param cmd: Command to be run
diff --git a/x2go/telekinesis.py b/x2go/telekinesis.py
index d34a5a6..bd3e751 100644
--- a/x2go/telekinesis.py
+++ b/x2go/telekinesis.py
@@ -77,7 +77,7 @@ class X2GoTelekinesisClient(threading.Thread):
@param sessions_rootdir: base dir where X2Go session files are stored (by default: ~/.x2go)
@type sessions_rootdir: C{str}
@param logger: you can pass an L{X2GoLogger} object to the
- L{X2GoProxy} constructor
+ L{X2GoTelekinesisClient} constructor
@param session_instance: the L{X2GoSession} instance this C{X2GoProxy*} instance belongs to
@type session_instance: L{X2GoSession} instance
@type logger: L{X2GoLogger} instance
--
Alioth's /srv/git/_hooks_/post-receive-email on /srv/git/code.x2go.org/python-x2go.git
More information about the x2go-commits
mailing list