Adding note about changes to disallow setting short_paths_home to be …

…a subdirectory of local conan cache (conan-io#1436)
Dattax · Oct 9, 2019 · 72c2fb5 · 72c2fb5
1 parent 8c7eb47
commit 72c2fb5
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/reference/config_files/conan.conf.rst b/reference/config_files/conan.conf.rst
@@ -201,6 +201,9 @@ If not specified, the packages marked as `short_paths` will be stored in the ``C
 If the variable is set to "None" will disable the `short_paths` feature in Windows,
 for modern Windows that enable long paths at the system level.
 
+Setting this variable equal to, or to a subdirectory of, the local conan cache (e.g. ~/.conan)
+would result in an invalid cache configuration and is therefore disallowed.
+
 The ``verbose_traceback`` variable will print the complete traceback when an error occurs in a recipe or even
 in the conan code base, allowing to debug the detected error.
 

diff --git a/reference/env_vars.rst b/reference/env_vars.rst
@@ -540,6 +540,9 @@ marked as `short_paths` will be stored in the ``C:\.conan`` (or the current driv
 
 If set to ``None``, it will disable the `short_paths` feature in Windows for modern Windows that enable long paths at the system level.
 
+Setting this variable equal to, or to a subdirectory of, the local conan cache (e.g. ~/.conan)
+would result in an invalid cache configuration and is therefore disallowed.
+
 CONAN_USE_ALWAYS_SHORT_PATHS
 ----------------------------