Add version and API version

- Add API version to constants.py
- Add version option to plugable.py
- Add version to ipa manpage and fix a couple of typos

https://fedorahosted.org/freeipa/ticket/4316

Reviewed-By: Petr Viktorin <pviktori@redhat.com>
This commit is contained in:
Gabe 2014-06-06 06:39:59 -06:00 committed by Petr Viktorin
parent ec282c7e96
commit 2a8c509567
3 changed files with 10 additions and 3 deletions

6
ipa.1
View File

@ -37,7 +37,7 @@ Load configuration from \fIFILE\fR.
\fB\-d\fR, \fB\-\-debug\fR \fB\-d\fR, \fB\-\-debug\fR
Produce full debugging output. Produce full debugging output.
.TP .TP
\fB\-\-\-delegate\fR \fB\-\-delegate\fR
Delegate the user's TGT to the IPA server Delegate the user's TGT to the IPA server
.TP .TP
\fB\-e\fR \fIKEY=VAL\fR \fB\-e\fR \fIKEY=VAL\fR
@ -56,7 +56,9 @@ Prompt for all parameters of \fICOMMAND\fR, even if they are optional.
Don't fall back to other IPA servers if the default doesn't work. Don't fall back to other IPA servers if the default doesn't work.
.TP .TP
\fB\-v\fR, \fB\-\-verbose\fR \fB\-v\fR, \fB\-\-verbose\fR
Produce verbose output. A second \-v displays the XML\-RPC request Produce verbose output. A second \-v displays the XML\-RPC request.
\fB\-\-version\fR
Display the IPA version and API version.
.SH "COMMANDS" .SH "COMMANDS"
The principal function of the CLI is to execute administrative commands specified by the \fICOMMAND\fR argument. The majority of commands are executed remotely over XML\-RPC on a IPA server listed in the configuration file (see FILES section of this manual page). The principal function of the CLI is to execute administrative commands specified by the \fICOMMAND\fR argument. The majority of commands are executed remotely over XML\-RPC on a IPA server listed in the configuration file (see FILES section of this manual page).

View File

@ -23,7 +23,8 @@ All constants centralised in one file.
""" """
import socket import socket
from ipapython.dn import DN from ipapython.dn import DN
from ipapython.version import VERSION from ipapython.version import VERSION, API_VERSION
try: try:
FQDN = socket.getfqdn() FQDN = socket.getfqdn()
except: except:
@ -65,6 +66,7 @@ CONFIG_SECTION = 'global'
# This is a tuple instead of a dict so that it is immutable. # This is a tuple instead of a dict so that it is immutable.
# To create a dict with this config, just "d = dict(DEFAULT_CONFIG)". # To create a dict with this config, just "d = dict(DEFAULT_CONFIG)".
DEFAULT_CONFIG = ( DEFAULT_CONFIG = (
('api_version', API_VERSION),
('version', VERSION), ('version', VERSION),
# Domain, realm, basedn: # Domain, realm, basedn:

View File

@ -43,6 +43,7 @@ from text import _
from base import ReadOnly, NameSpace, lock, islocked, check_name from base import ReadOnly, NameSpace, lock, islocked, check_name
from constants import DEFAULT_CONFIG from constants import DEFAULT_CONFIG
from ipapython.ipa_log_manager import * from ipapython.ipa_log_manager import *
from ipapython.version import VERSION, API_VERSION
# FIXME: Updated constants.TYPE_ERROR to use this clearer format from wehjit: # FIXME: Updated constants.TYPE_ERROR to use this clearer format from wehjit:
TYPE_ERROR = '%s: need a %r; got a %r: %r' TYPE_ERROR = '%s: need a %r; got a %r: %r'
@ -559,6 +560,8 @@ class API(DictProxy):
formatter=IPAHelpFormatter(), formatter=IPAHelpFormatter(),
usage='%prog [global-options] COMMAND [command-options]', usage='%prog [global-options] COMMAND [command-options]',
description='Manage an IPA domain', description='Manage an IPA domain',
version=('VERSION: %s, API_VERSION: %s'
% (VERSION, API_VERSION)),
epilog='\n'.join([ epilog='\n'.join([
'See "ipa help topics" for available help topics.', 'See "ipa help topics" for available help topics.',
'See "ipa help <TOPIC>" for more information on a ' 'See "ipa help <TOPIC>" for more information on a '