[Backport release/3.10] Document /vsicurl?empty_dir=yes option (#11358)

* Document empty_dir=yes * remove comment about empty_dir being undocumented --------- Co-authored-by: Scott Henderson <[email protected]>
OSGeo · Nov 26, 2024 · f354eeb · f354eeb
1 parent 6317c75
commit f354eeb
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 3 deletions.
diff --git a/doc/source/user/virtual_file_systems.rst b/doc/source/user/virtual_file_systems.rst
@@ -382,6 +382,7 @@ Starting with GDAL 2.3, options can be passed in the filename with the following
 - retry_delay=number_in_seconds: default to 30. Setting this option overrides the behavior of the :config:`GDAL_HTTP_RETRY_DELAY` configuration option.
 - retry_codes=``ALL`` or comma-separated list of HTTP error codes. Setting this option overrides the behavior of the :config:`GDAL_HTTP_RETRY_CODES` configuration option. (GDAL >= 3.10)
 - list_dir=yes/no: whether an attempt to read the file list of the directory where the file is located should be done. Default to YES.
+- empty_dir=yes/no: whether to disable directory listing and disable logic in drivers to probe for individual side-car files. Default to NO. 
 - useragent=value: HTTP UserAgent header
 - referer=value: HTTP Referer header
 - cookie=value: HTTP Cookie header

diff --git a/port/cpl_vsil_curl.cpp b/port/cpl_vsil_curl.cpp
@@ -365,9 +365,6 @@ static std::string VSICurlGetURLFromFilename(
                 }
                 else if (EQUAL(pszKey, "empty_dir"))
                 {
-                    /* Undocumented. Used by PLScenes driver */
-                    /* This more or less emulates the behavior of
-                     * GDAL_DISABLE_READDIR_ON_OPEN=EMPTY_DIR */
                     if (pbEmptyDir)
                         *pbEmptyDir = CPLTestBool(pszValue);
                 }