From a071ff91c39b7683e15f4e14a1efdd214e16ce4d Mon Sep 17 00:00:00 2001 From: Rui Chen Date: Mon, 10 Apr 2017 19:00:24 +0800 Subject: [PATCH] Add document about renaming OS_ENDPOINT_TYPE to OS_INTERFACE The patch https://review.openstack.org/#/c/198506/ rename option --os-endpoint-type to --os-interface a year ago, but lots of users switch to osc from these project specified clients, like: novaclient and neutronclient, they used OS_ENDPOINT_TYPE and --os-endpoint-type for long time, we should add the notes into openstackclient manpage, let them know the gap exists, and how to make it works. Change-Id: Ic84a60744aa4e519994a18104deae0c2b5b8b0ed Closes-Bug: #1678144 --- doc/source/man/openstack.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/source/man/openstack.rst b/doc/source/man/openstack.rst index 3021ef8756..66a99f3223 100644 --- a/doc/source/man/openstack.rst +++ b/doc/source/man/openstack.rst @@ -167,6 +167,11 @@ OPTIONS Interface type. Valid options are `public`, `admin` and `internal`. +.. NOTE:: + If you switch to openstackclient from project specified clients, like: + novaclient, neutronclient and so on, please use `--os-interface` instead of + `--os-endpoint-type`. + .. option:: --os-profile Performance profiling HMAC key for encrypting context data @@ -462,6 +467,10 @@ The following environment variables can be set to alter the behaviour of :progra Interface type. Valid options are `public`, `admin` and `internal`. +.. NOTE:: + If you switch to openstackclient from project specified clients, like: + novaclient, neutronclient and so on, please use `OS_INTERFACE` instead of + `OS_ENDPOINT_TYPE`. BUGS ====