From c80924cf261a8841604cf868c7137df41b71cb3f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 12 Aug 2022 09:47:30 +0200 Subject: [PATCH] (#12140) [docs] Regenerate tables of contents Co-authored-by: conan-center-bot --- docs/conandata_yml_format.md | 27 ++++++++++++++++++++++++++- docs/consuming_recipes.md | 7 ++++++- docs/policy_patching.md | 6 +++++- docs/v2_migration.md | 11 ++++++++++- docs/v2_roadmap.md | 18 +++++++++++++++++- 5 files changed, 64 insertions(+), 5 deletions(-) diff --git a/docs/conandata_yml_format.md b/docs/conandata_yml_format.md index 4badbfb6a2..a1222e4125 100644 --- a/docs/conandata_yml_format.md +++ b/docs/conandata_yml_format.md @@ -10,7 +10,32 @@ In the context of conan-center-index, this file is mandatory and consists of two * `patches`: Details about the different patches the library needs for several reasons. -## Contents +## Contents + + * [sources](#sources) + * [Mirrors](#mirrors) + * [Sources fields](#sources-fields) + * [url](#url) + * [sha256](#sha256) + * [sha1](#sha1) + * [md5](#md5) + * [Other cases](#other-cases) + * [Source code & license](#source-code--license) + * [Several source code archives](#several-source-code-archives) + * [Different source code archives per configuration](#different-source-code-archives-per-configuration) + * [patches](#patches) + * [Patches fields](#patches-fields) + * [patch_file](#patch_file) + * [patch_description](#patch_description) + * [patch_type](#patch_type) + * [official](#official) + * [vulnerability](#vulnerability) + * [backport](#backport) + * [portability](#portability) + * [conan](#conan) + * [patch_source](#patch_source) + * [base_path](#base_path) + * [sha256](#sha256-1) ## sources diff --git a/docs/consuming_recipes.md b/docs/consuming_recipes.md index a550976540..d0e0545fcd 100644 --- a/docs/consuming_recipes.md +++ b/docs/consuming_recipes.md @@ -5,7 +5,12 @@ fixing issues and adding new features every day. It is expected that from time t new recipe revisions stop to work in your project. -## Contents +## Contents + + * [Breaking changes](#breaking-changes) + * [Isolate your project from upstream changes](#isolate-your-project-from-upstream-changes) + * [Use your own Artifactory instance](#use-your-own-artifactory-instance) + * [Use recipe revisions and lockfiles](#use-recipe-revisions-and-lockfiles) ## Breaking changes diff --git a/docs/policy_patching.md b/docs/policy_patching.md index b80dc0ee8f..0d876f9a11 100644 --- a/docs/policy_patching.md +++ b/docs/policy_patching.md @@ -9,7 +9,11 @@ the library maintainers. -## Contents +## Contents + + * [Rules](#rules) + * [Exceptions](#exceptions) + * [Patches: format and conventions](#patches-format-and-conventions) ## Rules diff --git a/docs/v2_migration.md b/docs/v2_migration.md index 5779d031b7..58b2e63211 100644 --- a/docs/v2_migration.md +++ b/docs/v2_migration.md @@ -1,7 +1,16 @@ # Preparing recipes for Conan 2.0 -## Contents +## Contents + + * [New cpp_info set_property model](#new-cpp_info-set_property-model) + * [CMakeDeps](#cmakedeps) + * [Update required_conan_version to ">=1.43.0"](#update-required_conan_version-to-1430) + * [Translating .names information to cmake_target_name, cmake_module_target_name and cmake_file_name](#translating-names-information-to-cmake_target_name-cmake_module_target_name-and-cmake_file_name) + * [Translating .filenames information to cmake_file_name, cmake_module_file_name and cmake_find_mode](#translating-filenames-information-to-cmake_file_name-cmake_module_file_name-and-cmake_find_mode) + * [Understanding some workarounds with the .names attribute model in recipes](#understanding-some-workarounds-with-the-names-attribute-model-in-recipes) + * [Translating .build_modules to cmake_build_modules](#translating-build_modules-to-cmake_build_modules) + * [PkgConfigDeps](#pkgconfigdeps) > ⚠️ Refer to [road to Conan v2](v2_roadmap.md) to know the steps that > will be taken in ConanCenter and this repository to start running diff --git a/docs/v2_roadmap.md b/docs/v2_roadmap.md index 0da27f54ba..b666bf64a4 100644 --- a/docs/v2_roadmap.md +++ b/docs/v2_roadmap.md @@ -1,7 +1,23 @@ # Road to Conan v2 -## Contents +## Contents + + * [Short term](#short-term) + * [Prepare the CI infrastructure](#prepare-the-ci-infrastructure) + * [Export recipes using Conan v2 (warning)](#export-recipes-using-conan-v2-warning) + * [Prepare a syntax linter (CCI specific)](#prepare-a-syntax-linter-cci-specific) + * [Run an scheduled job exporting all recipes](#run-an-scheduled-job-exporting-all-recipes) + * [Mid term](#mid-term) + * [Add CI running Conan v2 (hidden)](#add-ci-running-conan-v2-hidden) + * [Show CI results to contributors (info)](#show-ci-results-to-contributors-info) + * [Linter - turn more warnings to errors](#linter---turn-more-warnings-to-errors) + * [Export using Conan v2 becomes an error](#export-using-conan-v2-becomes-an-error) + * [Long term](#long-term) + * [CI running v2 is reported (and required)](#ci-running-v2-is-reported-and-required) + * [Conan v2 remote](#conan-v2-remote) + * [Webpage with v2 information](#webpage-with-v2-information) + * [Future](#future) > ⚠️ **Note.-** This document is not a [guide about how to migrate recipes to Conan v2](v2_migration.md).