From 21155be2e4145f36e6255e5172f8134b959aa993 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Mon, 1 Jul 2024 12:24:08 +0100
Subject: [PATCH] docs: Fix indentation

Additional paragraphs in a rST list should be indented by the same
number of characters as the first paragraph otherwise it renders as a
block quote. Correct this for the backwards incompatible changes guide.

Change-Id: I918c2a24aead4cc5a317201df9b12ce740612e5a
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
---
 doc/source/cli/backwards-incompatible.rst | 394 +++++++++++-----------
 1 file changed, 202 insertions(+), 192 deletions(-)

diff --git a/doc/source/cli/backwards-incompatible.rst b/doc/source/cli/backwards-incompatible.rst
index 9d43754e01..3fbe65fae9 100644
--- a/doc/source/cli/backwards-incompatible.rst
+++ b/doc/source/cli/backwards-incompatible.rst
@@ -20,119 +20,129 @@ Release 4.0
 -----------
 
 1. Remove ``ip fixed add|remove`` commands.
+
    Use ``server add|remove fixed ip`` commands instead.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/612781
+   * Removed in: 4.0
+   * Commit: https://review.opendev.org/612781
 
 2. Remove ``ip floating add|remove`` commands.
+
    Use ``server add|remove floating ip`` commands instead.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/612781
+   * Removed in: 4.0
+   * Commit: https://review.opendev.org/612781
 
 3. Remove ``service create`` option ``--type``.  Service type is
    a positional argument.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/612798
+   * Removed in: 4.0
+   * Commit: https://review.opendev.org/612798
 
 4. Remove ``role list`` options ``--project`` and ``--user``.
+
    Use ``role assignment list`` options ``--project`` and ``--user`` instead.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/612798
+   * Removed in: 4.0
+   * Commit: https://review.opendev.org/612798
 
 5. Remove ``user role list`` command.
+
    Use ``role assignment list`` options ``--project`` and ``--user`` instead.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/612798
+   * Removed in: 4.0
+   * Commit: https://review.opendev.org/612798
 
 6. Remove ``image create|set`` option ``--owner``.
+
    Use ``--project`` option instead.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/659431
+   * Removed in: 4.0
+   * Commit: https://review.opendev.org/659431
 
 7. Remove ``port create|set`` options ``--device-id`` and ``--host-id``.
+
    Use ``--device`` and ``--host`` instead.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/613644
+   * Removed in: 4.0
+   * Commit: https://review.opendev.org/613644
 
 8. Remove ``router set`` option ``--clear-routes``.
+
    Use ``no-route`` option instead.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/613644
+   * Removed in: 4.0
+   * Commit: https://review.opendev.org/613644
 
 9. Remove ``security group rule create`` options ``--src-ip`` and ``--src-group``.
+
    Use ``--remote-ip`` and ``--remote-group`` options instead.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/613644
+   * Removed in: 4.0
+   * Commit: https://review.opendev.org/613644
 
 10. Remove ``backup`` commands.
+
     Use ``volume backup`` commands instead.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/612751
+    * Removed in: 4.0
+    * Commit: https://review.opendev.org/612751
 
 11. Remove ``snapshot`` commands.
     Use ``volume snapshot`` commands instead.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/612751
+    * Removed in: 4.0
+    * Commit: https://review.opendev.org/612751
 
 12. Remove ``volume create`` options ``--project``, ``--user``, ``--multi-attach``.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/612751
+    * Removed in: 4.0
+    * Commit: https://review.opendev.org/612751
 
 13. Change ``volume transfer request accept`` to use new option ``--auth-key``
     rather than a second positional argument.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/612751
+    * Removed in: 4.0
+    * Commit: https://review.opendev.org/612751
 
 14. Remove 'Token/Endpoint' auth plugin support (type ``token_endpoint``).
+
     This remained as a compatibility for the ``admin_token`` auth type to
     support the ``--url`` global option.  That option is also now removed,
     use ``--endpoint`` instead.
 
-  * Removed in: 4.0
-  * Commit: https://review.opendev.org/<tbd>
+    * Removed in: 4.0
+    * Commit: https://review.opendev.org/<tbd>
 
 Release 3.12
 ------------
 
 1. Replace ``Display Name`` by ``Name`` in volume list.
 
-  Change column name ``Display Name`` to ``Name`` in ``volume list`` output.
-  Current ``volume list --name`` command uses ``display_name`` as search_opts
-  to send to cinder API, and show the result table with ``Display Name``
-  as column title. Replace all ``Display Name`` by ``Name`` to be consistent
-  with other list commands.
+   Change column name ``Display Name`` to ``Name`` in ``volume list`` output.
+   Current ``volume list --name`` command uses ``display_name`` as search_opts
+   to send to cinder API, and show the result table with ``Display Name``
+   as column title. Replace all ``Display Name`` by ``Name`` to be consistent
+   with other list commands.
 
-  Support a mapping for volume list -c ``Display Name`` (Volume v1 and v2)
-  and volume create/show -c ``display_name`` (Volume v1) to maintain backward
-  compatibility until the next major release.
+   Support a mapping for volume list -c ``Display Name`` (Volume v1 and v2)
+   and volume create/show -c ``display_name`` (Volume v1) to maintain backward
+   compatibility until the next major release.
 
-  * In favor of: ``openstack volume list -c Name``
-  * As of: 3.12.0
-  * Removed in: n/a
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1657956
-  * Commit: https://review.opendev.org/#/c/423081/
+   * In favor of: ``openstack volume list -c Name``
+   * As of: 3.12.0
+   * Removed in: n/a
+   * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1657956
+   * Commit: https://review.opendev.org/#/c/423081/
 
 Release 3.10
 ------------
 
 1. The ``network create`` command now requires the ``--subnet`` option when used
-   with Nova-network clouds.
+   with nova-network clouds.
 
-  * As of: 3.10
-  * Commit: https://review.opendev.org/460679
+   * As of: 3.10
+   * Commit: https://review.opendev.org/460679
 
 2. The positional argument ``<snapshot-name>`` of the ``volume snapshot create``
    command is no longer optional.
@@ -142,23 +152,23 @@ Release 3.10
    ``--volume`` option is not present now it defaults to the value of
    ``<snapshot-name>``.
 
-  * As of: 3.10
-  * Bug: 1659894
-  * Commit: https://review.opendev.org/440497
+   * As of: 3.10
+   * Bug: 1659894
+   * Commit: https://review.opendev.org/440497
 
 Release 3.0
 -----------
 
 1. Remove the ``osc_password`` authentication plugin.
 
-  This was the 'last-resort' plugin default that worked around an old default
-  Keystone configuration for the ``admin_endpoint`` and ``public_endpoint``.
+   This was the 'last-resort' plugin default that worked around an old default
+   Keystone configuration for the ``admin_endpoint`` and ``public_endpoint``.
 
-  * In favor of: ``password``
-  * As of: 3.0
-  * Removed in: n/a
-  * Bug: n/a
-  * Commit: https://review.opendev.org/332938
+   * In favor of: ``password``
+   * As of: 3.0
+   * Removed in: n/a
+   * Bug: n/a
+   * Commit: https://review.opendev.org/332938
 
 
 Releases Before 3.0
@@ -166,209 +176,209 @@ Releases Before 3.0
 
 1. Rename command `openstack project usage list`
 
-  The `project` part of the command was pointless.
+   The `project` part of the command was pointless.
 
-  * In favor of: `openstack usage list` instead.
-  * As of: 1.0.2
-  * Removed in: TBD
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1406654
-  * Commit: https://review.opendev.org/#/c/147379/
+   * In favor of: `openstack usage list` instead.
+   * As of: 1.0.2
+   * Removed in: TBD
+   * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1406654
+   * Commit: https://review.opendev.org/#/c/147379/
 
 2. <type> should not be optional for command `openstack service create`
 
-  Previously, the command was `openstack service create <name> --type <type>`,
-  whereas now it is: `openstack service create <type> --name <name>`.
-  This bug also affected python-keystoneclient, and keystone.
+   Previously, the command was `openstack service create <name> --type <type>`,
+   whereas now it is: `openstack service create <type> --name <name>`.
+   This bug also affected python-keystoneclient, and keystone.
 
-  * In favor of: making <type> a positional argument.
-  * As of: 1.0.2
-  * Removed in: TBD
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1404073
-  * Commit: https://review.opendev.org/#/c/143242/
+   * In favor of: making <type> a positional argument.
+   * As of: 1.0.2
+   * Removed in: TBD
+   * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1404073
+   * Commit: https://review.opendev.org/#/c/143242/
 
 3. Command `openstack security group rule delete` now requires rule id
 
-  Previously, the command was `openstack security group rule delete --proto
-  <proto> [--src-ip <ip-address> --dst-port <port-range>] <group>`,
-  whereas now it is: `openstack security group rule delete <rule>`.
+   Previously, the command was `openstack security group rule delete --proto
+   <proto> [--src-ip <ip-address> --dst-port <port-range>] <group>`,
+   whereas now it is: `openstack security group rule delete <rule>`.
 
-  * In favor of: Using `openstack security group rule delete <rule>`.
-  * As of: 1.2.1
-  * Removed in: NA
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1450872
-  * Commit: https://review.opendev.org/#/c/179446/
+   * In favor of: Using `openstack security group rule delete <rule>`.
+   * As of: 1.2.1
+   * Removed in: NA
+   * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1450872
+   * Commit: https://review.opendev.org/#/c/179446/
 
 4. Command `openstack image create` does not update already existing image
 
-  Previously, the image create command updated already existing image if it had
-  same name. It disabled possibility to create multiple images with same name
-  and lead to potentially unwanted update of existing images by image create
-  command.
-  Now, update code was moved from create action to set action.
+   Previously, the image create command updated already existing image if it had
+   same name. It disabled possibility to create multiple images with same name
+   and lead to potentially unwanted update of existing images by image create
+   command.
+   Now, update code was moved from create action to set action.
 
-  * In favor of: Create multiple images with same name (as glance does).
-  * As of: 1.5.0
-  * Removed in: NA
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1461817
-  * Commit: https://review.opendev.org/#/c/194654/
+   * In favor of: Create multiple images with same name (as glance does).
+   * As of: 1.5.0
+   * Removed in: NA
+   * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1461817
+   * Commit: https://review.opendev.org/#/c/194654/
 
 5. Command `openstack network list --dhcp` has been removed
 
-  The --dhcp option to network list is not a logical use case of listing
-  networks, it lists agents.  Another command should be added in the future
-  to provide this functionality.  It is highly unlikely anyone uses this
-  feature as we don't support any other agent commands.  Use neutron
-  dhcp-agent-list-hosting-net command instead.
+   The --dhcp option to network list is not a logical use case of listing
+   networks, it lists agents.  Another command should be added in the future
+   to provide this functionality.  It is highly unlikely anyone uses this
+   feature as we don't support any other agent commands.  Use neutron
+   dhcp-agent-list-hosting-net command instead.
 
-  * In favor of: Create network agent list command in the future
-  * As of: 1.6.0
-  * Removed in: NA
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/472613
-  * Commit: https://review.opendev.org/#/c/194654/
+   * In favor of: Create network agent list command in the future
+   * As of: 1.6.0
+   * Removed in: NA
+   * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/472613
+   * Commit: https://review.opendev.org/#/c/194654/
 
 6. Plugin interface change for default API versions
 
-  Previously, the default version was set in the parsed arguments,
-  but this makes it impossible to tell what has been passed in at the
-  command line, set in an environment variable or is just the default.
-  Now, the module should have a DEFAULT_API_VERSION that contains the
-  value and it will be set after command line argument, environment
-  and OCC file processing.
+   Previously, the default version was set in the parsed arguments,
+   but this makes it impossible to tell what has been passed in at the
+   command line, set in an environment variable or is just the default.
+   Now, the module should have a DEFAULT_API_VERSION that contains the
+   value and it will be set after command line argument, environment
+   and OCC file processing.
 
-  * In favor of: DEFAULT_API_VERSION
-  * As of: 1.2.1
-  * Removed in: NA
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1453229
-  * Commit: https://review.opendev.org/#/c/181514/
+   * In favor of: DEFAULT_API_VERSION
+   * As of: 1.2.1
+   * Removed in: NA
+   * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1453229
+   * Commit: https://review.opendev.org/#/c/181514/
 
 7. `image set` commands will no longer return the modified resource
 
-  Previously, modifying an image would result in the new image being displayed
-  to the user. To keep things consistent with other `set` commands, we will
-  no longer be showing the modified resource.
+   Previously, modifying an image would result in the new image being displayed
+   to the user. To keep things consistent with other `set` commands, we will
+   no longer be showing the modified resource.
 
-  * In favor of: Use `set` then `show`
-  * As of: NA
-  * Removed in: NA
-  * Bug: NA
-  * Commit: NA
+   * In favor of: Use `set` then `show`
+   * As of: NA
+   * Removed in: NA
+   * Bug: NA
+   * Commit: NA
 
 8. `region` commands no longer support `url`
 
-  The Keystone team removed support for the `url` attribute from the client
-  and server side. Changes to the `create`, `set` and `list` commands for
-  regions have been affected.
+   The Keystone team removed support for the `url` attribute from the client
+   and server side. Changes to the `create`, `set` and `list` commands for
+   regions have been affected.
 
-  * In favor of: NA
-  * As of 1.9.0
-  * Removed in: NA
-  * Bug: https://launchpad.net/bugs/1506841
-  * Commit: https://review.opendev.org/#/c/236736/
+   * In favor of: NA
+   * As of 1.9.0
+   * Removed in: NA
+   * Bug: https://launchpad.net/bugs/1506841
+   * Commit: https://review.opendev.org/#/c/236736/
 
 9. `flavor set/unset` commands will no longer return the modified resource
 
-  Previously, modifying a flavor would result in the new flavor being displayed
-  to the user. To keep things consistent with other `set/unset` commands, we
-  will no longer be showing the modified resource.
+   Previously, modifying a flavor would result in the new flavor being displayed
+   to the user. To keep things consistent with other `set/unset` commands, we
+   will no longer be showing the modified resource.
 
-  * In favor of: Use `set/unset` then `show`
-  * As of: NA
-  * Removed in: NA
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
-  * Commit: https://review.opendev.org/#/c/280663/
+   * In favor of: Use `set/unset` then `show`
+   * As of: NA
+   * Removed in: NA
+   * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
+   * Commit: https://review.opendev.org/#/c/280663/
 
 10. `security group set` commands will no longer return the modified resource
 
-  Previously, modifying a security group would result in the new security group
-  being displayed to the user. To keep things consistent with other `set`
-  commands, we will no longer be showing the modified resource.
+    Previously, modifying a security group would result in the new security group
+    being displayed to the user. To keep things consistent with other `set`
+    commands, we will no longer be showing the modified resource.
 
-  * In favor of: Use `set` then `show`
-  * As of: NA
-  * Removed in: NA
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
-  * Commit: https://review.opendev.org/#/c/281087/
+    * In favor of: Use `set` then `show`
+    * As of: NA
+    * Removed in: NA
+    * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
+    * Commit: https://review.opendev.org/#/c/281087/
 
 11. `compute agent set` commands will no longer return the modified resource
 
-  Previously, modifying an agent would result in the new agent being displayed
-  to the user. To keep things consistent with other `set` commands, we will
-  no longer be showing the modified resource.
+    Previously, modifying an agent would result in the new agent being displayed
+    to the user. To keep things consistent with other `set` commands, we will
+    no longer be showing the modified resource.
 
-  * In favor of: Use `set` then `show`
-  * As of: NA
-  * Removed in: NA
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
-  * Commit: https://review.opendev.org/#/c/281088/
+    * In favor of: Use `set` then `show`
+    * As of: NA
+    * Removed in: NA
+    * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
+    * Commit: https://review.opendev.org/#/c/281088/
 
 12. `<version> <url> <md5hash>` should be optional for command `openstack
     compute agent set`
 
-  Previously, the command was `openstack compute agent set <id> <version> <url>
-  <md5hash>`, whereas now it is: `openstack compute agent set <id> --version
-  <version> --url <url> --md5hash <md5hash>`.
+    Previously, the command was `openstack compute agent set <id> <version> <url>
+    <md5hash>`, whereas now it is: `openstack compute agent set <id> --version
+    <version> --url <url> --md5hash <md5hash>`.
 
-  * In favor of: making <version> <url> <md5hash> optional.
-  * As of: NA
-  * Removed in: NA
-  * Bug: NA
-  * Commit: https://review.opendev.org/#/c/328819/
+    * In favor of: making <version> <url> <md5hash> optional.
+    * As of: NA
+    * Removed in: NA
+    * Bug: NA
+    * Commit: https://review.opendev.org/#/c/328819/
 
 13. `aggregate set` commands will no longer return the modified resource
 
-  Previously, modifying an aggregate would result in the new aggregate being
-  displayed to the user. To keep things consistent with other `set` commands,
-  we will no longer be showing the modified resource.
+    Previously, modifying an aggregate would result in the new aggregate being
+    displayed to the user. To keep things consistent with other `set` commands,
+    we will no longer be showing the modified resource.
 
-  * In favor of: Use `set` then `show`
-  * As of: NA
-  * Removed in: NA
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
-  * Commit: https://review.opendev.org/#/c/281089/
+    * In favor of: Use `set` then `show`
+    * As of: NA
+    * Removed in: NA
+    * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
+    * Commit: https://review.opendev.org/#/c/281089/
 
 14. Output of `ip floating list` command has changed.
 
-  When using Compute v2, the original output is:
+    When using Compute v2, the original output is:
 
-  .. code-block:: bash
+    .. code-block:: bash
 
-      # ip floating list
+        # ip floating list
 
-      +----+--------+------------+----------+-------------+
-      | ID | Pool   | IP         | Fixed IP | Instance ID |
-      +----+--------+-----------------------+-------------+
-      |  1 | public | 172.24.4.1 | None     | None        |
-      +----+--------+------------+----------+-------------+
+        +----+--------+------------+----------+-------------+
+        | ID | Pool   | IP         | Fixed IP | Instance ID |
+        +----+--------+-----------------------+-------------+
+        |  1 | public | 172.24.4.1 | None     | None        |
+        +----+--------+------------+----------+-------------+
 
-  Now it changes to:
+    Now it changes to:
 
-  .. code-block:: bash
+    .. code-block:: bash
 
-      # ip floating list
+        # ip floating list
 
-      +----+---------------------+------------------+-----------+--------+
-      | ID | Floating IP Address | Fixed IP Address | Server ID | Pool   |
-      +----+---------------------+------------------+-----------+--------+
-      |  1 | 172.24.4.1          | None             | None      | public |
-      +----+---------------------+------------------+-----------+--------+
+        +----+---------------------+------------------+-----------+--------+
+        | ID | Floating IP Address | Fixed IP Address | Server ID | Pool   |
+        +----+---------------------+------------------+-----------+--------+
+        |  1 | 172.24.4.1          | None             | None      | public |
+        +----+---------------------+------------------+-----------+--------+
 
-  When using Network v2, which is different from Compute v2. The output is:
+    When using Network v2, which is different from Compute v2. The output is:
 
-  .. code-block:: bash
+    .. code-block:: bash
 
-      # ip floating list
+        # ip floating list
 
-      +--------------------------------------+---------------------+------------------+------+
-      | ID                                   | Floating IP Address | Fixed IP Address | Port |
-      +--------------------------------------+---------------------+------------------+------+
-      | 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3          | None             | None |
-      +--------------------------------------+---------------------+------------------+------+
+        +--------------------------------------+---------------------+------------------+------+
+        | ID                                   | Floating IP Address | Fixed IP Address | Port |
+        +--------------------------------------+---------------------+------------------+------+
+        | 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3          | None             | None |
+        +--------------------------------------+---------------------+------------------+------+
 
-  * In favor of: Use `ip floating list` command
-  * As of: NA
-  * Removed in: NA
-  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1519502
-  * Commit: https://review.opendev.org/#/c/277720/
+    * In favor of: Use `ip floating list` command
+    * As of: NA
+    * Removed in: NA
+    * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1519502
+    * Commit: https://review.opendev.org/#/c/277720/
 
 For Developers
 ==============