Skip to content

Commit

Permalink
Release/2.0.1 docs (#3051)
Browse files Browse the repository at this point in the history
* Fix command conan remote (#3031)

* Fix conan remote add -h content

* Fix indentation

* Change 'optional arguments' to 'options'

Makes it identical to the actual command line output.

* Add info on .conanignore (#3036)

* Add info on .conanignore

* Add missing point

* Update conan config install documentation (#3035)

* Fix conan remote auth help typo (#3039)

* Fix conan remote auth help typo

* Fix whitespace issue

* fix typo for import syntax (#3024)

* Update tools.rst (#3047)

Fix typo

* Change documentation from conan-io/conan#13211 (#3046)

* add docs (#3049)

* remove from docs (#3050)

* 2.0.1 docs

---------

Co-authored-by: Kasurus <38571075+Kasurus@users.noreply.github.com>
Co-authored-by: Rubén Rincón Blanco <rubenrb@jfrog.com>
Co-authored-by: Chris Mc <christopherm@jfrog.com>
Co-authored-by: Caijinglong <cjl_spy@163.com>
  • Loading branch information
5 people authored Mar 3, 2023
1 parent 365474b commit 618f06e
Show file tree
Hide file tree
Showing 31 changed files with 131 additions and 172 deletions.
29 changes: 29 additions & 0 deletions changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,35 @@ Changelog

For a more detailed description of the major changes that Conan 2.0 brings, compared with Conan 1.X, please read :ref:`whatsnew`

2.0.1 (03-Mar-2023)
-------------------

- Feature: Add `--insecure` alias to `--verify-ssl` in config install. `#13270 <https://github.com/conan-io/conan/pull/13270>`_ . Docs `here <https://github.com/conan-io/docs/pull/3035>`__
- Feature: Add `.conanignore` support to `conan config install`. `#13269 <https://github.com/conan-io/conan/pull/13269>`_ . Docs `here <https://github.com/conan-io/docs/pull/3036>`__
- Feature: Make verbose tracebacks on exception be shown for ``-vv`` and ``-vvv``, instead of custom env-var used in 1.X. `#13226 <https://github.com/conan-io/conan/pull/13226>`_
- Fix: Minor improvements to :command:`conan install` and 2.0-readiness error messages. `#13299 <https://github.com/conan-io/conan/pull/13299>`_
- Fix: Remove ``vcvars.bat`` VS telemetry env-var, to avoid Conan hanging. `#13293 <https://github.com/conan-io/conan/pull/13293>`_
- Fix: Remove legacy ``CMakeToolchain`` support for ``CMakePresets`` schema2 for ``CMakeUserPresets.json``. `#13288 <https://github.com/conan-io/conan/pull/13288>`_ . Docs `here <https://github.com/conan-io/docs/pull/3049>`__
- Fix: Remove ``--logger`` json logging and legacy traces. `#13287 <https://github.com/conan-io/conan/pull/13287>`_ . Docs `here <https://github.com/conan-io/docs/pull/3050>`__
- Fix: Fix typo in `conan remote auth` help. `#13285 <https://github.com/conan-io/conan/pull/13285>`_ . Docs `here <https://github.com/conan-io/docs/pull/3039>`__
- Fix: Raise arg error if ``conan config list unexpected-arg``. `#13282 <https://github.com/conan-io/conan/pull/13282>`_
- Fix: Do not auto-detect ``compiler.runtime_type`` for ``msvc``, rely on profile plugin. `#13277 <https://github.com/conan-io/conan/pull/13277>`_
- Fix: Fix conanfile.txt options parsing error message. `#13266 <https://github.com/conan-io/conan/pull/13266>`_
- Fix: Improve error message for unified patterns in options. `#13264 <https://github.com/conan-io/conan/pull/13264>`_
- Fix: Allow ``conan remote add --force`` to force re-definition of an existing remote name. `#13249 <https://github.com/conan-io/conan/pull/13249>`_
- Fix: Restore printing of profiles for build command. `#13214 <https://github.com/conan-io/conan/pull/13214>`_
- Fix: Change :command:`conan build` argument description for "path" to indicate it is only for conanfile.py and explicitly state that it does not work with conanfile.txt. `#13211 <https://github.com/conan-io/conan/pull/13211>`_ . Docs `here <https://github.com/conan-io/docs/pull/3046>`__
- Fix: Better error message when dependencies ``options`` are defined in ``requirements()`` method. `#13207 <https://github.com/conan-io/conan/pull/13207>`_
- Fix: Fix broken links to docs from error messages and readme. `#13186 <https://github.com/conan-io/conan/pull/13186>`_
- Bugfix: Ensure that `topics` are always serialized as lists. `#13298 <https://github.com/conan-io/conan/pull/13298>`_
- Bugfix: Ensure that `provides` are always serialized as lists. `#13298 <https://github.com/conan-io/conan/pull/13298>`_
- Bugfix: Fixed the detection of certain visual c++ installations. `#13284 <https://github.com/conan-io/conan/pull/13284>`_
- Bugfix: Fix supported ``cppstd`` values for ``msvc`` compiler. `#13278 <https://github.com/conan-io/conan/pull/13278>`_
- Bugfix: CMakeDeps generate files for ``tool_requires`` with the same ``build_type`` as the "host" context. `#13267 <https://github.com/conan-io/conan/pull/13267>`_
- Bugfix: Fix definition of patterns for dependencies options in configure(). `#13263 <https://github.com/conan-io/conan/pull/13263>`_
- Bugfix: Fix CMakeToolchain error when output folder in different Win drive. `#13248 <https://github.com/conan-io/conan/pull/13248>`_
- Bugfix: Do not raise errors if a ``test_requires`` is not used by components ``.requires``. `#13191 <https://github.com/conan-io/conan/pull/13191>`_

2.0.0 (22-Feb-2023)
-------------------

Expand Down
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
# The short X.Y version.
version = "2.0"
# The full version, including alpha/beta/rc tags.
release = u'2.0.0'
release = u'2.0.1'

dir_path = os.path.dirname(os.path.realpath(__file__))
if not os.path.exists(os.path.join(dir_path, "versions.json")):
Expand Down
10 changes: 4 additions & 6 deletions reference/commands/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ conan build
.. code-block:: text
$ conan build -h
usage: conan build [-h] [-v [V]] [--logger] [--name NAME] [--version VERSION]
usage: conan build [-h] [-v [V]] [--name NAME] [--version VERSION]
[--user USER] [--channel CHANNEL] [-of OUTPUT_FOLDER]
[-b BUILD] [-r REMOTE | -nr] [-u] [-o OPTIONS_HOST]
[-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] [-pr PROFILE_HOST]
Expand All @@ -21,18 +21,16 @@ conan build
Install dependencies and call the build() method.
positional arguments:
path Path to a folder containing a recipe (conanfile.py or
conanfile.txt) or to a recipe file. e.g.,
./my_project/conanfile.txt.
path Path to a python-based recipe file or a folder
containing a conanfile.py recipe. conanfile.txt cannot
be used with conan build.
optional arguments:
-h, --help show this help message and exit
-v [V] Level of detail of the output. Valid options from less
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
--name NAME Provide a package name if not specified in conanfile
--version VERSION Provide a package version if not specified in
conanfile
Expand Down
9 changes: 3 additions & 6 deletions reference/commands/cache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ conan cache path
.. code-block:: text
$ conan cache path --help
usage: conan cache path [-h] [-v [V]] [--logger] [--folder {export_source,source,build}] reference
usage: conan cache path [-h] [-v [V]] [--folder {export_source,source,build}] reference
Show the path to the Conan cache for a given reference.
Expand All @@ -25,8 +25,6 @@ conan cache path
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
--folder {export_source,source,build}
Path to show. The 'build' requires a package
reference. If not specified it shows 'exports' path
Expand Down Expand Up @@ -160,7 +158,7 @@ conan cache clean
.. code-block:: text
$ conan cache clean -h
usage: conan cache clean [-h] [-v [V]] [--logger] [-s] [-b] [-d]
usage: conan cache clean [-h] [-v [V]] [-s] [-b] [-d]
[-p PACKAGE_QUERY]
pattern
Expand All @@ -176,8 +174,7 @@ conan cache clean
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
-s, --source Clean source folders
-b, --build Clean build folders
-d, --download Clean download folders
Expand Down
24 changes: 13 additions & 11 deletions reference/commands/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,14 @@ conan config home
.. code-block:: text
$ conan config home --help
usage: conan config home [-h] [-v [V]] [--logger]
usage: conan config home [-h] [-v [V]]
Show the Conan home folder.
optional arguments:
-h, --help show this help message and exit
-v [V] Level of detail of the output. Valid options from less verbose
to more verbose: -vquiet, -verror, -vwarning, -vnotice,
-vstatus, -v or -vverbose, -vv or -vdebug, -vvv or -vtrace
--logger Show the output with log format, with time, type and message.
The ``conan config home`` command returns the path of the Conan home folder.
Expand All @@ -37,8 +35,8 @@ conan config install
.. code-block:: text
$ conan config install -h
usage: conan config install [-h] [-v [V]] [--logger]
[--verify-ssl [VERIFY_SSL]]
usage: conan config install [-h] [-v [V]]
[--verify-ssl [VERIFY_SSL] | --insecure]
[-t {git,dir,file,url}] [-a ARGS]
[-sf SOURCE_FOLDER] [-tf TARGET_FOLDER]
item
Expand All @@ -56,10 +54,10 @@ conan config install
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
--verify-ssl [VERIFY_SSL]
Verify SSL connection when downloading file
--insecure Allow insecure server connections when using SSL.
Equivalent to --verify-ssl=False
-t {git,dir,file,url}, --type {git,dir,file,url}
Type of remote config
-a ARGS, --args ARGS String with extra arguments for "git clone"
Expand Down Expand Up @@ -91,6 +89,12 @@ All the configuration files can be shared and installed this way:
- All the extensions, including plugins, hooks.
- Custom user commands.

This command reads a ``.conanignore`` file which, if present, filters which files and folders
are copied over to the user's Conan home folder.
This file uses `fnmatch <https://docs.python.org/3/library/fnmatch.html>`_ patterns
to match over the folder contents, excluding those entries that match from the config installation.
See `conan-io/command-extensions's .conanignore <https://github.com/conan-io/command-extensions/blob/main/.conanignore>`_ for an example of such a file.


**Examples**:

Expand Down Expand Up @@ -155,7 +159,7 @@ conan config list
.. code-block:: text
$ conan config list -h
usage: conan config list [-h] [-f FORMAT] [-v [V]] [--logger]
usage: conan config list [-h] [-f FORMAT] [-v [V]]
Show all the Conan available configurations: core and tools.
Expand All @@ -167,8 +171,7 @@ conan config list
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
Displays all the Conan built-in configurations. There are 2 groups:
Expand Down Expand Up @@ -224,7 +227,6 @@ Displays all the Conan built-in configurations. There are 2 groups:
tools.build:skip_test: Do not execute CMake.test() and Meson.test() when enabled
tools.build:sysroot: Pass the --sysroot=<tools.build:sysroot> flag if available. (None by default)
tools.cmake.cmake_layout:build_folder_vars: Settings and Options that will produce a different build folder and different CMake presets names
tools.cmake.cmaketoolchain.presets:max_schema_version: Generate CMakeUserPreset.json compatible with the supplied schema version
tools.cmake.cmaketoolchain:find_package_prefer_config: Argument for the CMAKE_FIND_PACKAGE_PREFER_CONFIG
tools.cmake.cmaketoolchain:generator: User defined CMake generator to use instead of default
tools.cmake.cmaketoolchain:system_name: Define CMAKE_SYSTEM_NAME in CMakeToolchain
Expand Down
4 changes: 1 addition & 3 deletions reference/commands/create.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ conan create
.. code-block:: text
$ conan create -h
usage: conan create [-h] [-f FORMAT] [-v [V]] [--logger] [--name NAME]
usage: conan create [-h] [-f FORMAT] [-v [V]] [--name NAME]
[--version VERSION] [--user USER] [--channel CHANNEL]
[-l LOCKFILE] [--lockfile-partial]
[--lockfile-out LOCKFILE_OUT] [--lockfile-packages]
Expand All @@ -30,8 +30,6 @@ conan create
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
--name NAME Provide a package name if not specified in conanfile
--version VERSION Provide a package version if not specified in
conanfile
Expand Down
4 changes: 1 addition & 3 deletions reference/commands/download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ conan download
.. code-block:: text
$ conan download -h
usage: conan download [-h] [-v [V]] [--logger] [--only-recipe]
usage: conan download [-h] [-v [V]] [--only-recipe]
[-p PACKAGE_QUERY] -r REMOTE
reference
Expand All @@ -28,8 +28,6 @@ conan download
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
--only-recipe Download only the recipe/s, not the binary packages.
-p PACKAGE_QUERY, --package-query PACKAGE_QUERY
Only upload packages matching a specific query. e.g:
Expand Down
8 changes: 2 additions & 6 deletions reference/commands/editable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ conan editable add
.. code-block:: text
$ conan editable add -h
usage: conan editable add [-h] [-v [V]] [--logger] [--name NAME]
usage: conan editable add [-h] [-v [V]] [--name NAME]
[--version VERSION] [--user USER]
[--channel CHANNEL] [-of OUTPUT_FOLDER]
path
Expand All @@ -29,8 +29,6 @@ conan editable add
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
--name NAME Provide a package name if not specified in conanfile
--version VERSION Provide a package version if not specified in
conanfile
Expand All @@ -45,7 +43,7 @@ conan editable remove
.. code-block:: text
$ conan editable remove -h
usage: conan editable remove [-h] [-v [V]] [--logger] [-r REFS] [path]
usage: conan editable remove [-h] [-v [V]] [-r REFS] [path]
Remove the "editable" mode for this reference.
Expand All @@ -60,6 +58,4 @@ conan editable remove
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
-r REFS, --refs REFS Directly provide reference patterns
4 changes: 1 addition & 3 deletions reference/commands/export-pkg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ conan export-pkg
.. code-block:: text
$ conan export-pkg -h
usage: conan export-pkg [-h] [-f FORMAT] [-v [V]] [--logger]
usage: conan export-pkg [-h] [-f FORMAT] [-v [V]]
[-of OUTPUT_FOLDER] [--build-require]
[-tf TEST_FOLDER] [--name NAME] [--version VERSION]
[--user USER] [--channel CHANNEL] [-l LOCKFILE]
Expand All @@ -33,8 +33,6 @@ conan export-pkg
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
-of OUTPUT_FOLDER, --output-folder OUTPUT_FOLDER
The root output folder for generated and build files
--build-require Whether the provided reference is a build-require
Expand Down
4 changes: 1 addition & 3 deletions reference/commands/export.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ conan export
.. code-block:: text
$ conan export -h
usage: conan export [-h] [-f FORMAT] [-v [V]] [--logger] [--name NAME]
usage: conan export [-h] [-f FORMAT] [-v [V]] [--name NAME]
[--version VERSION] [--user USER] [--channel CHANNEL]
[-r REMOTE | -nr] [-l LOCKFILE]
[--lockfile-out LOCKFILE_OUT] [--lockfile-partial]
Expand All @@ -24,8 +24,6 @@ conan export
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
--name NAME Provide a package name if not specified in conanfile
--version VERSION Provide a package version if not specified in
conanfile
Expand Down
4 changes: 1 addition & 3 deletions reference/commands/graph/build_order.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ conan graph build-order
.. code-block:: text
$ conan graph build-order -h
usage: conan graph build-order [-h] [-f FORMAT] [-v [V]] [--logger]
usage: conan graph build-order [-h] [-f FORMAT] [-v [V]]
[--name NAME] [--version VERSION] [--user USER]
[--channel CHANNEL] [--requires REQUIRES]
[--tool-requires TOOL_REQUIRES] [-b BUILD]
Expand Down Expand Up @@ -35,8 +35,6 @@ conan graph build-order
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
--name NAME Provide a package name if not specified in conanfile
--version VERSION Provide a package version if not specified in
conanfile
Expand Down
4 changes: 1 addition & 3 deletions reference/commands/graph/build_order_merge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ conan graph build-order-merge
.. code-block:: text
$ conan graph build-order-merge -h
usage: conan graph build-order-merge [-h] [-f FORMAT] [-v [V]] [--logger]
usage: conan graph build-order-merge [-h] [-f FORMAT] [-v [V]]
[--file [FILE]]
Merge more than 1 build-order file.
Expand All @@ -18,6 +18,4 @@ conan graph build-order-merge
verbose to more verbose: -vquiet, -verror, -vwarning,
-vnotice, -vstatus, -v or -vverbose, -vv or -vdebug,
-vvv or -vtrace
--logger Show the output with log format, with time, type and
message.
--file [FILE] Files to be merged
Loading

0 comments on commit 618f06e

Please sign in to comment.