openstack/python-openstackclient
Code Issues Proposed changes

Update documentation with info about setup.cfg

Browse Source 
Change-Id: If87df1e6415d0b70b6605b1d89eda639fc44a0b6
This commit is contained in:
Monty Taylor
2013-07-05 22:30:54 -04:00
parent bf3ee1e9a5
commit d7501c352d
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/commands.rst
View File

@@ -41,20 +41,19 @@ of Cliff's command.Command object.
Command Entry Points Command Entry Points
-------------------- --------------------
Commands are added to the client using distribute's entry points in ``setup.py``. Commands are added to the client using setuptools's entry points in ``setup.cfg``.
There is a single common group ``openstack.cli`` for commands that are not versioned, There is a single common group ``openstack.cli`` for commands that are not versioned,
and a group for each combination of OpenStack API and version that is and a group for each combination of OpenStack API and version that is
supported. For example, to support Identity API v3 there is a group called supported. For example, to support Identity API v3 there is a group called
``openstack.identity.v3`` that contains the individual commands. The command ``openstack.identity.v3`` that contains the individual commands. The command
entry points have the form:: entry points have the form::
"verb_object=fully.qualified.module.vXX.object:VerbObject" verb_object = fully.qualified.module.vXX.object:VerbObject
For example, the 'list user' command fir the Identity API is identified in For example, the 'list user' command fir the Identity API is identified in
``setup.py`` with:: ``setup.cfg`` with::
'openstack.identity.v3': [ openstack.identity.v3 =
# ... # ...
'list_user=openstackclient.identity.v3.user:ListUser', list_user = openstackclient.identity.v3.user:ListUser
# ... # ...
],