Skip to content

Commit

Permalink
Automatic deploy (build number 16)
Browse files Browse the repository at this point in the history
  • Loading branch information
ConanCI bot committed Mar 5, 2024
1 parent 69daedc commit 451b78b
Show file tree
Hide file tree
Showing 148 changed files with 518 additions and 658 deletions.
Expand Up @@ -81,8 +81,5 @@ You can try and create the ``say`` package:
.. seealso::

- Read more about the :ref:`layout method<reference_conanfile_methods_layout>` and :ref:`how the
package layout works<tutorial_package_layout>`.



- :ref:`layout method<reference_conanfile_methods_layout>`
- :ref:`how the package layout works<tutorial_package_layout>`.
10 changes: 5 additions & 5 deletions 2.1/_sources/examples/cross_build/android/ndk.rst.txt
Expand Up @@ -81,9 +81,9 @@ Both the library and the ``test_package`` executable are built for Android, so w
Unless you have access to a `root` Android device, running the test application or using the built library is not possible
directly so it is more common to build an Android application that uses the ``hello`` library.

Read more
---------
.. seealso::

- Check the example :ref:`Integrating Conan in Android Studio<examples_cross_build_android_studio>` to know how to use your
c++ libraries in a native Android application.
- Check the tutorial :ref:`How to cross-compile your applications using Conan<consuming_packages_cross_building_with_conan>`.
- Check the example :ref:`Integrating Conan in Android Studio<examples_cross_build_android_studio>` to know how to use your
c++ libraries in a native Android application.
- Check the tutorial :ref:`How to cross-compile your applications using Conan<consuming_packages_cross_building_with_conan>`.

Expand Up @@ -51,10 +51,11 @@ It is also possible to assign a value for a given setting, for example if we wan

If we want to be able to create, store and manage different binaries for different input settings, information erasure can't be used, and using the below ``compatibility`` approaches is recommended.

Read more about ``package_id()`` in:

- :ref:`creating_packages_configure_options_settings`
- :ref:`package_id() method reference<reference_conanfile_methods_package_id>`
.. seealso::

- :ref:`creating_packages_configure_options_settings`
- :ref:`package_id() method reference<reference_conanfile_methods_package_id>`


The compatibility() method
Expand Down
4 changes: 1 addition & 3 deletions 2.1/_sources/reference/commands/install.rst.txt
Expand Up @@ -203,11 +203,9 @@ to resolve the new one, which was not previously present in the lockfile, and st
Also, it is likely that the majority of lockfile operations are better managed by the ``conan lock`` command.


Read more about lockfiles in :ref:`tutorial_consuming_packages_versioning_lockfiles`.

.. seealso::

- :ref:`tutorial_consuming_packages_versioning_lockfiles`.
- Read the tutorial about the :ref:`local package development flow <local_package_development_flow>`.


Expand Down
9 changes: 4 additions & 5 deletions 2.1/_sources/reference/commands/remote.rst.txt
Expand Up @@ -95,9 +95,8 @@ conan remote update
:command: conan remote update -h


Read more
---------
.. seealso::

- :ref:`Uploading packages tutorial <uploading_packages>`
- :ref:`Working with Conan repositories <conan_repositories>`
- :ref:`Upload Conan packages to remotes using conan upload command <reference_commands_upload>`
- :ref:`Uploading packages tutorial <uploading_packages>`
- :ref:`Working with Conan repositories <conan_repositories>`
- :ref:`Upload Conan packages to remotes using conan upload command <reference_commands_upload>`
11 changes: 5 additions & 6 deletions 2.1/_sources/reference/commands/upload.rst.txt
Expand Up @@ -26,10 +26,9 @@ Using the ``core.upload:parallel`` conf, it is possible to upload packages in pa
By default, or when set to a value less than ``2``, no parallelization will take place,
and any other value will be the number of parallel threads to utilize.

Read more
---------
.. seealso::

- :ref:`Uploading packages tutorial <uploading_packages>`
- :ref:`Working with Conan repositories <conan_repositories>`
- :ref:`Managing remotes with conan remote command <reference_commands_remote>`
- :ref:`Uploading metadata files<devops_metadata>`.
- :ref:`Uploading packages tutorial <uploading_packages>`
- :ref:`Working with Conan repositories <conan_repositories>`
- :ref:`Managing remotes with conan remote command <reference_commands_remote>`
- :ref:`Uploading metadata files<devops_metadata>`.
2 changes: 1 addition & 1 deletion 2.1/_sources/reference/conanfile/methods/generate.rst.txt
Expand Up @@ -271,4 +271,4 @@ the dependency is in the cache or is an :ref:`editable package<editable_packages

.. seealso::

Read more about the :ref:`CppInfo<conan_conanfile_model_cppinfo>` model.
- :ref:`CppInfo<conan_conanfile_model_cppinfo>` model.
5 changes: 2 additions & 3 deletions 2.1/_sources/reference/conanfile/methods/layout.rst.txt
Expand Up @@ -99,9 +99,8 @@ There are three objects available in the ``layout()`` method:
.. seealso::

Read more about the usage of the ``layout()`` in :ref:`this
tutorial<developing_packages_layout>` and Conan package layout
:ref:`here<tutorial_package_layout>`.
- Read more about the usage of the ``layout()`` in :ref:`this tutorial<developing_packages_layout>` and Conan package layout
- :ref:`here<tutorial_package_layout>`.


Environment variables and configuration
Expand Down
5 changes: 2 additions & 3 deletions 2.1/_sources/reference/conanfile_txt.rst.txt
Expand Up @@ -134,7 +134,6 @@ You can specify one name of a predefined layout. The available values are:
cmake_layout
Read more
---------
.. seealso::

Read :ref:`consuming_packages_flexibility_of_conanfile_py` for more information about conanfile.txt vs conanfile.py.
Read :ref:`consuming_packages_flexibility_of_conanfile_py` for more information about conanfile.txt vs conanfile.py.
14 changes: 4 additions & 10 deletions 2.1/_sources/reference/extensions/custom_commands.rst.txt
Expand Up @@ -245,13 +245,7 @@ These are the passed arguments to any custom command and its sub-commands functi
Normally, they'll be parsed as ``args = parser.parse_args(*args)``. For instance, running :command:`conan mycommand arg1 arg2 arg3`,
the command function will receive them as a Python list-like ``["arg1", "arg2", "arg3"]``.

Read more
---------

- :ref:`Custom command to remove recipe and package revisions but the latest package one
from the latest recipe one<examples_extensions_commands_clean_revisions>`.
- You can check more examples of Conan custom command in the *conan-extensions* repository.
There you can find examples of custom commands without sub-commands `like this one
<https://github.com/conan-io/conan-extensions/blob/main/extensions/commands/art/cmd_server.py>`__.
and custom commands with sub-commands `like this one
<https://github.com/conan-io/conan-extensions/blob/main/extensions/commands/cci/cmd_export_all_versions.py>`__.
.. seealso::

- :ref:`Custom command to remove recipe and package revisions but the latest package one from the latest recipe one<examples_extensions_commands_clean_revisions>`.
- You can check more examples of Conan custom command in the *conan-extensions* repository https://github.com/conan-io/conan-extensions
7 changes: 3 additions & 4 deletions 2.1/_sources/reference/extensions/python_api/ConanAPI.rst.txt
Expand Up @@ -11,9 +11,8 @@ Conan API Reference
:members:


Read more
---------
.. seealso::

- Creating Conan custom commands
- ...
- Creating Conan custom commands
- ...

5 changes: 2 additions & 3 deletions 2.1/_sources/reference/tools/meson/mesontoolchain.rst.txt
Expand Up @@ -287,10 +287,9 @@ in this example of host profile:
tools.android:ndk_path=/my/path/to/NDK
Read more
---------
.. seealso::

- :ref:`Getting started with Meson<examples_tools_meson_toolchain_build_simple_meson_project>`
- :ref:`Getting started with Meson<examples_tools_meson_toolchain_build_simple_meson_project>`


.. _MesonToolchain Reference:
Expand Down
Expand Up @@ -58,9 +58,8 @@ You can check the package existence on your local computer again with:
$ conan list hello
Read more
---------
.. seealso::

- :ref:`conan upload command reference <reference_commands_upload>`
- :ref:`conan remote command reference <reference_commands_remote>`
- :ref:`conan search command reference <reference_commands_search>`
- :ref:`conan upload command reference <reference_commands_upload>`
- :ref:`conan remote command reference <reference_commands_remote>`
- :ref:`conan search command reference <reference_commands_search>`
Expand Up @@ -266,9 +266,8 @@ Now we are ready to build and run our **compressor** app:
.. _consuming_packages_read_more:

Read more
---------
.. seealso::

- :ref:`Getting started with Autotools<examples_tools_autotools_autotools_toolchain_build_project_autotools_toolchain>`
- :ref:`Getting started with Meson<examples_tools_meson_toolchain_build_simple_meson_project>`
- :ref:`Getting started with Bazel<examples_tools_bazel_toolchain_build_simple_bazel_project>`
- :ref:`Getting started with Autotools<examples_tools_autotools_autotools_toolchain_build_project_autotools_toolchain>`
- :ref:`Getting started with Meson<examples_tools_meson_toolchain_build_simple_meson_project>`
- :ref:`Getting started with Bazel<examples_tools_bazel_toolchain_build_simple_bazel_project>`
Expand Up @@ -207,10 +207,7 @@ You could check that we built the application for the correct architecture by ru
stripped
Read more
---------

.. container:: examples
.. seealso::

- :ref:`Cross building to Android with the NDK<examples_cross_build_android_ndk>`
- :ref:`VirtualBuildEnv reference <conan_tools_env_virtualbuildenv>`
Expand Down
Expand Up @@ -321,13 +321,12 @@ In the context of our tutorial, when we consumed Zlib with different `settings`
matched our specified configuration.
Read more
---------
- :ref:`VirtualRunEnv reference <conan_tools_env_virtualrunenv>`
- :ref:`Cross-compiling using --profile:build and --profile:host <consuming_packages_cross_building_with_conan>`
- :ref:`creating_packages_configure_options_settings`
- :ref:`Installing configurations with conan config install <reference_commands_conan_config_install>`
- VS Multi-config
- Example about how settings and options influence the package id
- :ref:`Using patterns for settings and options <reference_config_files_profile_patterns>`
.. seealso::
- :ref:`VirtualRunEnv reference <conan_tools_env_virtualrunenv>`
- :ref:`Cross-compiling using --profile:build and --profile:host <consuming_packages_cross_building_with_conan>`
- :ref:`creating_packages_configure_options_settings`
- :ref:`Installing configurations with conan config install <reference_commands_conan_config_install>`
- VS Multi-config
- Example about how settings and options influence the package id
- :ref:`Using patterns for settings and options <reference_config_files_profile_patterns>`
Expand Up @@ -217,8 +217,7 @@ Note how the version range is no longer resolved, and it doesn't get the ``zlib/
allowed range ``zlib/[~1.2]``, because the ``conan.lock`` lockfile is forcing it to stay in ``zlib/1.2.11`` and that exact revision too.


Read more
---------
.. seealso::

- :ref:`Introduction to Versioning<tutorial_versioning>`
- :ref:`Introduction to Versioning<tutorial_versioning>`

Expand Up @@ -346,10 +346,7 @@ Windows or that you want to use the system's CMake installation instead of using
self.tool_requires("cmake/3.22.6")
Read more
---------

.. container:: examples
.. seealso::

- :ref:`Using "cmake_layout" + "CMakeToolchain" + "CMakePresets feature" to build your project<examples-tools-cmake-toolchain-build-project-presets>`.
- :ref:`Understanding the Conan Package layout<tutorial_package_layout>`.
Expand Down
Expand Up @@ -234,12 +234,11 @@ the environment activation:
use ``tool_requires`` to depend on library or library-like dependencies.


Read more
---------

- :ref:`Using [system_tools] in your profiles <reference_config_files_profiles_system_tools>`.
- :ref:`Creating recipes for tool_requires: packaging build tools <tutorial_other_tool_requires_packages>`.
- :ref:`examples_graph_tool_requires_protobuf`
- Using MinGW as tool_requires
- :ref:`Using tool_requires in profiles <reference_config_files_profile_patterns>`
- Using conf to set a toolchain from a tool requires
.. seealso::

- :ref:`Using [system_tools] in your profiles <reference_config_files_profiles_system_tools>`.
- :ref:`Creating recipes for tool_requires: packaging build tools <tutorial_other_tool_requires_packages>`.
- :ref:`examples_graph_tool_requires_protobuf`
- Using MinGW as tool_requires
- :ref:`Using tool_requires in profiles <reference_config_files_profile_patterns>`
- Using conf to set a toolchain from a tool requires
Expand Up @@ -117,8 +117,7 @@ colour now:
hello/1.0: __clang_minor__ 1
hello/1.0: __apple_build_version__ 13160021
Read more
---------
.. seealso::

- :ref:`Reference for requirements() method <reference_conanfile_methods_requirements>`.
- :ref:`Introduction to versioning <consuming_packages_intro_versioning>`.
- :ref:`Reference for requirements() method <reference_conanfile_methods_requirements>`.
- :ref:`Introduction to versioning <consuming_packages_intro_versioning>`.
Expand Up @@ -299,7 +299,6 @@ CMake and in Linux and MacOS using Autotools. This can be easily handled in the
...
Read more
---------
.. seealso::
- :ref:`Patching sources <examples_tools_files_patches>`
- :ref:`Patching sources <examples_tools_files_patches>`
Expand Up @@ -272,11 +272,10 @@ way the package ID for the package is calculated. You can also check the :ref:`C
methods reference<reference_conanfile_methods>` if you want to know how this method works in
more detail.

Read more
---------

- :ref:`Header-only packages<creating_packages_other_header_only>`.
- Check the binary compatibility :ref:`compatibility.py extension <reference_extensions_binary_compatibility>`.
- Conan :ref:`package types<reference_conanfile_attributes_package_type>`.
- :ref:`Setting package_id_mode for requirements <reference_conanfile_methods_requirements_package_id_mode>`.
- Read the :ref:`binary model reference<reference_binary_model>` for a full view of the Conan binary model.
.. seealso::

- :ref:`Header-only packages<creating_packages_other_header_only>`.
- Check the binary compatibility :ref:`compatibility.py extension <reference_extensions_binary_compatibility>`.
- Conan :ref:`package types<reference_conanfile_attributes_package_type>`.
- :ref:`Setting package_id_mode for requirements <reference_conanfile_methods_requirements_package_id_mode>`.
- Read the :ref:`binary model reference<reference_binary_model>` for a full view of the Conan binary model.
Expand Up @@ -335,9 +335,8 @@ in the local cache.
An **important** note: the Conan cache is private to the Conan client - modifying, adding, removing or changing files inside the Conan cache is undefined behaviour likely to cause breakages.


Read more
---------
.. seealso::

- :ref:`Create your first Conan package with Visual Studio/MSBuild<examples_tools_microsoft_create_first_package>`.
- :ref:`CMake built-in integrations reference<conan_tools_cmake>`.
- :ref:`conan create command reference<reference_commands_create>` and :ref:`Conan list command reference<reference_commands_list>`.
- :ref:`Create your first Conan package with Visual Studio/MSBuild<examples_tools_microsoft_create_first_package>`.
- :ref:`CMake built-in integrations reference<conan_tools_cmake>`.
- :ref:`conan create command reference<reference_commands_create>` and :ref:`Conan list command reference<reference_commands_list>`.
Expand Up @@ -343,15 +343,8 @@ To know more about this use case, please check the :ref:`components
example<examples_conanfile_package_info_components>` in the examples section.


Read more
---------

.. container:: examples
.. seealso::

- :ref:`Propagating environment and configuration information to consumers example<examples_conanfile_package_info_conf_and_env>`
- :ref:`Define components for Conan packages that provide multiple libraries example<examples_conanfile_package_info_components>`


.. seealso::

- :ref:`package_info() reference<reference_conanfile_methods_package_info>`
Expand Up @@ -247,12 +247,8 @@ zip file has the correct ``sha256``. So we could modify the source method to thi
Read more
---------

- :ref:`Patching sources<examples_tools_files_patches>`
- :ref:`Capturing Git SCM source information<examples_tools_scm_git_capture>` instead of copying sources with ``exports_sources``.

.. seealso::

- :ref:`Patching sources<examples_tools_files_patches>`
- :ref:`Capturing Git SCM source information<examples_tools_scm_git_capture>` instead of copying sources with ``exports_sources``.
- :ref:`source() method reference<reference_conanfile_methods_source>`
Expand Up @@ -231,10 +231,9 @@ So, if we call :command:`conan create` with different ``build_type`` we will get
We got the same binary ``package_id``. The second ``conan create . -s build_type=Debug`` created and overwrote (created a newer package revision) of the previous Release binary, because they have the same ``package_id`` identifier. It is typical to create only the ``Release`` one, and if for any reason managing both Debug and Release binaries is intended, then the approach would be not removing the ``del self.info.settings.build_type``


Read more
---------
.. seealso::

- - :ref:`examples_graph_tool_requires_protobuf`
- Toolchains (compilers)
- :ref:`Usage of runenv_info<reference_conanfile_methods_package_info_runenv_info>`
- :ref:`More info on settings_target<binary_model_extending_cross_build_target_settings>`
- - :ref:`examples_graph_tool_requires_protobuf`
- Toolchains (compilers)
- :ref:`Usage of runenv_info<reference_conanfile_methods_package_info_runenv_info>`
- :ref:`More info on settings_target<binary_model_extending_cross_build_target_settings>`
Expand Up @@ -168,11 +168,7 @@ absolute links into relative paths and make the package relocatable.
absolute_to_relative_symlinks(self, self.package_folder)
Read more
---------

- :ref:`Package method reference<reference_conanfile_methods_package>`

.. seealso::

- :ref:`Package method reference<reference_conanfile_methods_package>`
- :ref:`package() method reference<reference_conanfile_methods_package>`
Expand Up @@ -190,12 +190,8 @@ could do in the ``generate()`` method like:
* Adding custom configurations besides *Release* and *Debug*, taking into account the
settings, like *ReleaseShared* or *DebugShared*.

Read more
---------

- Use the ``generate()`` method to import files from dependencies.
- More based on the examples mentioned above ...

.. seealso::

- Use the ``generate()`` method to import files from dependencies.
- More based on the examples mentioned above ...
- :ref:`generate() method reference<reference_conanfile_methods_generate>`

0 comments on commit 451b78b

Please sign in to comment.