[libcloud] 05/10: Add an example directory layout to upgrade notes.

[to...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tomaz pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/libcloud.git

commit e6efd8b0486c22748661786d1071b604026d2051
Author: Tomaz Muraus <to...@tomaz.me>
AuthorDate: Sat Dec 19 12:59:52 2020 +0100

    Add an example directory layout to upgrade notes.
---
 docs/upgrade_notes.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/docs/upgrade_notes.rst b/docs/upgrade_notes.rst
index e7b3048..6be4833 100644
--- a/docs/upgrade_notes.rst
+++ b/docs/upgrade_notes.rst
@@ -75,6 +75,51 @@ Libcloud 3.3.0
   slashes or similar and are upgrading from Libcloud ``v2.3.0`` or older where
   no path sanitization was performed.
 
+  Example S3 bucket layout with this option disabled (default) and enabled.
+
+  Object with the following name: ``/my-bucket/sub-directory/file.txt``
+
+    .. code-block:: bash
+
+      # Disabled
+
+      root
+      +-- my-bucket/
+        +-- sub-directory/
+          +-- file.txt
+
+      # Enabled
+
+      root
+      +-- /
+        +-- my-bucket/
+          +-- sub-directory/
+            +-- file.txt
+
+  Object with the following name: ``/my-bucket//directory1/file.txt``
+
+    .. code-block:: bash
+
+      # Disabled
+
+      root
+      +-- my-bucket/
+        +-- directory1/
+          +-- file.txt
+
+      # Enabled
+
+      root
+      +-- /
+        +-- my-bucket/
+          +-- /
+            +-- directory1/
+              +-- file.txt
+
+  As you can see from the examples above, directory layout is not the same
+  with this option enabled and disabled so you should be careful when you
+  use it.
+
 Libcloud 3.2.0
 --------------