conf is read-only (#3449)

* conf is read-only * Update reference/conanfile/attributes.rst Co-authored-by: Carlos Zoido <mrgalleta@gmail.com> --------- Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
conan-io · Nov 7, 2023 · 59979a5 · 59979a5
1 parent 5660561
commit 59979a5
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/reference/conanfile/attributes.rst b/reference/conanfile/attributes.rst
@@ -73,6 +73,12 @@ The profile entries have priority.
           self.output.info("Custom var1: %s" % self.conf.get("user.custom.var1"))
 
 
+.. note::
+
+    The ``conf`` attribute is a **read-only** attribute. It can only be defined in profiles and command lines, but it should never be set by recipes.
+    Recipes can only read its value via ``self.conf.get()`` method.
+
+
 Output
 ------