diff options
| author | Jenkins <jenkins@review.openstack.org> | 2017-02-20 18:54:55 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2017-02-20 18:54:55 +0000 |
| commit | 91f7451180a88bee4d9e26738bb62c48a37a2451 (patch) | |
| tree | 84cabb8618b0c542a486c94a67a8263c3d60d26a | |
| parent | 1e3faf9f64f36df351a15bd444d3024d9a7beeff (diff) | |
| parent | 76c7ab5c85b6c9271664d2c9227cd7f7b785889a (diff) | |
| download | python-openstackclient-91f7451180a88bee4d9e26738bb62c48a37a2451.tar.gz | |
Merge "Remove text about OSC as a plugin requirement"
| -rw-r--r-- | doc/source/plugins.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst index eafe5e8f..054e552f 100644 --- a/doc/source/plugins.rst +++ b/doc/source/plugins.rst @@ -190,12 +190,15 @@ unit tests for the plugin commands: Requirements ------------ -OSC must be included in ``requirements.txt`` or ``test-requirements.txt`` -for the plugin project. Update ``requirements.txt`` if the plugin project -considers the CLI a required feature. Update ``test-requirements.txt`` if -the plugin project can be installed as a library with the CLI being an +OSC should be included in the plugin's ``test-requirements.txt`` if +the plugin can be installed as a library with the CLI being an optional feature (available when OSC is also installed). +OSC should not appear in ``requirements.txt`` unless the plugin project +wants OSC and all of its dependencies installed with it. This is +specifically not a good idea for plugins that are also libraries +installed with OpenStack services. + .. code-block:: ini python-openstackclient>=X.Y.Z # Apache-2.0 |