Sync 'develop' with 'master' (#1651)

* fix dupe changelog (#1617) Co-authored-by: Daniel <danimanzaneque@gmail.com> * Convert all references to lowercase (#1619) * Convert all references to lowercase * fix * Update developing_packages/workspaces.rst * Update developing_packages/workspaces.rst * Update howtos/manage_shared_libraries/env_vars.rst * Update creating_packages/define_abi_compatibility.rst Co-Authored-By: Javier G. Sogo <jgsogo@gmail.com> * Update creating_packages/define_abi_compatibility.rst Co-Authored-By: Javier G. Sogo <jgsogo@gmail.com> * Update creating_packages/define_abi_compatibility.rst Co-Authored-By: Javier G. Sogo <jgsogo@gmail.com> * Update creating_packages/define_abi_compatibility.rst Co-Authored-By: Javier G. Sogo <jgsogo@gmail.com> * Update creating_packages/define_abi_compatibility.rst Co-Authored-By: Javier G. Sogo <jgsogo@gmail.com> * Update creating_packages/define_abi_compatibility.rst Co-Authored-By: Javier G. Sogo <jgsogo@gmail.com> * Update creating_packages/define_abi_compatibility.rst Co-Authored-By: Javier G. Sogo <jgsogo@gmail.com> * Update creating_packages/define_abi_compatibility.rst Co-Authored-By: Javier G. Sogo <jgsogo@gmail.com> * Update devtools/build_requires.rst Co-Authored-By: Javier G. Sogo <jgsogo@gmail.com> * Update creating_packages/define_abi_compatibility.rst Co-Authored-By: Javier G. Sogo <jgsogo@gmail.com> * Update creating_packages/define_abi_compatibility.rst Co-Authored-By: Javier G. Sogo <jgsogo@gmail.com> Co-authored-by: Javier G. Sogo <jgsogo@gmail.com> * Remove linkcheck from master jobs (#1633) * Remove old stuff from building scripts: elasticsearch, old deploy commands (#1634) * Remove linkcheck from master jobs * remove indexing stuff from deploy script * remove old gh_pages script * remove nginx script * remove make_mac * remove elastic stuff Co-authored-by: Javier G. Sogo <jgsogo@gmail.com> * #1506 Add Troubleshooting for duplicated package (#1507) * #1506 Add Troubleshooting for duplicated package Signed-off-by: Uilian Ries <uilianries@gmail.com> * #1506 Better block format Signed-off-by: Uilian Ries <uilianries@gmail.com> * #1506 Better block format Signed-off-by: Uilian Ries <uilianries@gmail.com> * Change the perspective to transitive package Signed-off-by: Uilian Ries <uilianries@gmail.com> Co-authored-by: Javier G. Sogo <jgsogo@gmail.com> * Use the build folder to apply any patch (#1605) * Use the build folder to apply any patch Some motivation: conan-io/conan-center-index#1107 (comment) Signed-off-by: Uilian Ries <uilianries@gmail.com> * Update build folder comment Signed-off-by: Uilian Ries <uilianries@gmail.com> * Update reference/tools.rst Co-authored-by: Javier G. Sogo <jgsogo@gmail.com> Co-authored-by: Daniel <danimanzaneque@gmail.com> * Remove redundant text in visualstudio.rst (#1625) Co-authored-by: Javier G. Sogo <jgsogo@gmail.com> * Add information about matrix-params in the artifacts.properties reference (#1487) * add matrix-params to docs * finally landed in 7.3.2 * Update reference/config_files/artifacts.properties.rst Co-Authored-By: Carlos Zoido <mrgalleta@gmail.com> Co-authored-by: Carlos Zoido <mrgalleta@gmail.com> * change version and changelog * unicode char not allowed (#1649) * Updates docs related to 'remotes.json' file (#1640) * document remotes.json * add note about metadata.josn * update docs in remote command * remove non public files * remove unneeded change Co-authored-by: Carlos Zoido <mrgalleta@gmail.com> * fix python_requires_copy (#1647) Co-authored-by: Daniel <danimanzaneque@gmail.com> Co-authored-by: Carlos Zoido <mrgalleta@gmail.com> Co-authored-by: Daniel <danimanzaneque@gmail.com> Co-authored-by: Uilian Ries <uilianries@gmail.com> Co-authored-by: syntroniks <syntroniks@gmail.com> Co-authored-by: James <james@conan.io>
conan-io · Apr 1, 2020 · ea4a550 · ea4a550
1 parent a78d158
commit ea4a550
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 86 deletions.
diff --git a/reference/commands/consumer/config.rst b/reference/commands/consumer/config.rst
@@ -121,14 +121,9 @@ the *~/.conan* folder. Its format is a list of entries, one on each line, with t
     [remote name] [remote url] [bool]
 
 where ``[bool]`` (either ``True`` or ``False``) indicates whether SSL should be used to verify that remote. The remote definitions can be
-found in the *registry.txt*/*registry.json* files and they provide a helpful starting point when writing the *remotes.txt* to be packaged in
+found in the *remotes.json* file and it provides a helpful starting point when writing the *remotes.txt* to be packaged in
 a Conan client configuration.
 
-.. important::
-    The local cache *registry.txt*/*registry.json* file contains the remotes definitions as well as the mapping of installed packages from
-    remotes. Sharing the complete contents of this file via this command is not recommended as this records the status of the local cache,
-    which may be different from one machine to another.
-
 .. note::
     During the installation, Conan skips any file with the name *README.md* or *LICENSE.txt*.
 

diff --git a/reference/commands/misc/remote.rst b/reference/commands/misc/remote.rst
@@ -47,15 +47,16 @@ Manages the remote list and the package recipes associated to a remote.
 
       $ conan remote list
       conan-center: https://conan.bintray.com [Verify SSL: True]
-      local: http://localhost:9300 [Verify SSL: True]
+      local: http://localhost:9300 [Verify SSL: True, Disabled: True]
 
-- List remotes in a format valid for *remotes.txt* (:command:`conan config install`):
+- List remotes in a format almost valid for the *remotes.txt* to use with :ref:`conan_config_install`, only need
+  to remove the ``True`` boolean appended to disabled remotes (notice line for ``local`` one in the output):
 
   .. code-block:: bash
 
       $ conan remote list --raw
       conan-center https://conan.bintray.com True
-      local http://localhost:9300 True
+      local http://localhost:9300 True True
       # capture the current remotes in a text file
       $ conan remote list --raw > remotes.txt
 

diff --git a/reference/conanfile/attributes.rst b/reference/conanfile/attributes.rst
@@ -1296,13 +1296,14 @@ be computed. It can take three different values:
 
 .. _python_requires_attribute:
 
-python_requires
----------------
+python_requires (legacy)
+------------------------
 
 .. warning::
 
-    This attribute is part of the :ref:`python requires<python_requires>` feature, so
-    it is also an **experimental** feature subject to breaking changes in future releases.
+    This attribute has been superseded by the new :ref:`python_requires`. Even if this is an **experimental**
+    feature subject to breaking changes in future releases, this legacy ``python_requires`` syntax has not
+    been removed yet, but it will be removed in Conan 2.0.
 
 Python requires are associated with the ``ConanFile`` declared in the recipe file, data
 from those imported recipes is accessible using the ``python_requires`` attribute in
@@ -1327,7 +1328,34 @@ workspace.:
 
         def source(self):
             pyreq = self.python_requires['pyreq']
-            self.copy("CMakeLists.txt", src=pyreq.exports_sources_folder, dst=self.source_folder)
+            path = os.path.join(pyreq.exports_sources_folder, "CMakeLists.txt")
+            shutil.copy(src=path, dst=self.source_folder)
+
+python_requires
+---------------
+
+.. warning::
+
+    This is an **experimental** feature subject to breaking changes in future releases.
+
+This class attribute allows to define a dependency to another Conan recipe and reuse its code.
+Its basic syntax is:
+
+.. code-block:: python
+
+    from conans import ConanFile
+
+    class Pkg(ConanFile):
+        python_requires = "pyreq/0.1@user/channel"  # recipe to reuse code from
+
+        def build(self):
+            self.python_requires["pyreq"].module # access to the whole conanfile.py module
+            self.python_requires["pyreq"].module.myvar  # access to a variable
+            self.python_requires["pyreq"].module.myfunct()  # access to a global function
+            self.python_requires["pyreq"].path # access to the folder where the reused file is
+
+
+Read more about this attribute in :ref:`python_requires`
 
 .. _conandata_attribute:
 

diff --git a/reference/config_files.rst b/reference/config_files.rst
@@ -9,12 +9,11 @@ These are the most important configuration files, used to customize conan.
 .. toctree::
    :maxdepth: 2
 
+   config_files/artifacts.properties
+   config_files/client_certificates
    config_files/conan.conf
+   config_files/conandata.yml
    config_files/default_profile
-   config_files/settings.yml
-   config_files/registry.txt
-   config_files/client_certificates
-   config_files/artifacts.properties
    config_files/editable_layout
-   config_files/conandata.yml
+   config_files/settings.yml
 
diff --git a/reference/config_files/registry.txt.rst b/reference/config_files/registry.txt.rst
diff --git a/reference/generators/markdown.rst b/reference/generators/markdown.rst
@@ -10,7 +10,7 @@ using different build systems,...
 
 .. code-block:: bash
 
-    ⇒  conan install libxml2/2.9.9@ --generator markdown
+    $ conan install libxml2/2.9.9@ --generator markdown
     ...
     Generator markdown created libxml2.md