Commit Graph

38 Commits

Author SHA1 Message Date
Chris Mc
dfda985713 (#17705) docs: remove mention of the migration test_v1_package
* Delete docs/package_templates/autotools_package/all/test_v1_package directory

* Delete docs/package_templates/cmake_package/all/test_v1_package directory

* Delete docs/package_templates/header_only/all/test_v1_package directory

* Delete docs/package_templates/meson_package/all/test_v1_package directory

* Delete docs/package_templates/msbuild_package/all/test_v1_package directory

* Delete docs/package_templates/prebuilt_tool_package/all/test_v1_package directory

* Update test_packages.md

* Update error_knowledge_base.md
2023-05-25 21:21:44 +02:00
Chris Mc
3f27b6db0f (#16759) docs: clarify everything should use CMake 3.15 to match Conan 2.0 2023-04-01 11:45:37 +02:00
Uilian Ries
6e151164ce (#16199) Update documentation URLs to use Conan v1 dedicated address
* update conan V1 docs url

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* revert non docs

Signed-off-by: Uilian Ries <uilianries@gmail.com>

---------

Signed-off-by: Uilian Ries <uilianries@gmail.com>
2023-03-23 19:04:53 +01:00
Uilian Ries
99d5b17141 (#15382) [docs] Add hooks description for KB-H076 and KB-H077
* Add hooks 76 and 77

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Update docs/error_knowledge_base.md

Co-authored-by: SSE4 <tomskside@gmail.com>

* Update docs/error_knowledge_base.md

Co-authored-by: SpaceIm <30052553+SpaceIm@users.noreply.github.com>

* Update docs/error_knowledge_base.md

Co-authored-by: SpaceIm <30052553+SpaceIm@users.noreply.github.com>

Signed-off-by: Uilian Ries <uilianries@gmail.com>
Co-authored-by: SSE4 <tomskside@gmail.com>
Co-authored-by: SpaceIm <30052553+SpaceIm@users.noreply.github.com>
2023-01-25 11:08:46 +01:00
Chris Mc
7129c016cb (#15004) docs: split out files and folders and the last few attributes
* docs: organize "adding packages" by files and methods

* typo

* modernize the main readme + second pass to improve language

* [docs] Regenerate tables of contents

Co-authored-by: prince-chrismc <prince-chrismc@users.noreply.github.com>

* update the folder and files to match other recent changes

* Apply suggestions from code review

Co-authored-by: SSE4 <tomskside@gmail.com>

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: prince-chrismc <prince-chrismc@users.noreply.github.com>
Co-authored-by: SSE4 <tomskside@gmail.com>
2023-01-25 10:07:45 +01:00
Chris Mc
56d8bf909f (#14896) docs: Improve language around folder layouts from hooks
* Update error_knowledge_base.md

* link to repo + where to put exception
2022-12-22 19:25:31 +01:00
Chris Mc
9a8423f47f (#14856) docs: Move build system examples to new file
* docs: Move build system examples to new file

* Apply suggestions from code review

Co-authored-by: SSE4 <tomskside@gmail.com>

Co-authored-by: SSE4 <tomskside@gmail.com>
2022-12-22 10:25:40 +01:00
Chris Mc
1be2642ab7 (#14833) docs: add working with dependencies to give a lot more guidance
* docs: fix TOC

* docs: first pass at `requirements`

* review + fill in generate to build details

* tweak my choice of words more

* move version ranges docs

* point hooks to full explainer

* cleanup

* cleanup more

* Apply suggestions from code review

Co-authored-by: SSE4 <tomskside@gmail.com>

Co-authored-by: SSE4 <tomskside@gmail.com>
2022-12-20 10:05:32 +01:00
Chris Mc
073a9a9909 (#14491) Docs: split up reviewing into new file sections
* cleanup patches from #14377

* subfolder dont exist with new generators

* styling is not enforced

* move attribute to new home + fix FAQ spelling

* delete out date CMake docs from older generators

* move test package docs

* delete empty file :)

* fix links

* wording + remove duplicated sections

* improve mention of future work

* [docs] Regenerate tables of contents

Co-authored-by: prince-chrismc <prince-chrismc@users.noreply.github.com>

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: prince-chrismc <prince-chrismc@users.noreply.github.com>
2022-12-02 14:25:04 +01:00
Uilian Ries
6ec76996d5 (#14385) [docs] New hook kb-h075: Override is not allowed
Signed-off-by: Uilian Ries <uilianries@gmail.com>

Signed-off-by: Uilian Ries <uilianries@gmail.com>
2022-11-23 18:47:54 +01:00
Chris Mc
e70b881101 (#14211) docs: split some policies by the implicated method
* docs: split some policies by the implicated method

* fix broken link

* fix broken link

* Apply suggestions from code review

Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>
Co-authored-by: SSE4 <tomskside@gmail.com>

Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>
Co-authored-by: SSE4 <tomskside@gmail.com>
2022-11-21 18:45:43 +01:00
Chris Mc
edacf97622 (#13736) docs: Create a subfolder for "adding packages"
* docs: group files about "adding packages"

* fixing links

* fixing links

* rename file

* minor changes

* fix merge conflicts

* touch ups

* fix order

* fix links

* Clean up notes

* Update docs/error_knowledge_base.md

* Update docs/developing_recipes_locally.md

* merge conflicts

* Apply suggestions from code review
2022-11-15 08:06:29 +01:00
Uilian Ries
47bac9d8b8 (#13309) Add KB-H072 and KB-H073 to docs
* Add KB-H072 and KB-H073 to docs

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Update docs/error_knowledge_base.md

Co-authored-by: Jordan Williams <jordan@jwillikers.com>

* Update docs/error_knowledge_base.md

Co-authored-by: Jordan Williams <jordan@jwillikers.com>

* Update docs/error_knowledge_base.md

Co-authored-by: Chris Mc <prince.chrismc@gmail.com>

* Update docs/error_knowledge_base.md

Co-authored-by: Jordan Williams <jordan@jwillikers.com>

Signed-off-by: Uilian Ries <uilianries@gmail.com>
Co-authored-by: Jordan Williams <jordan@jwillikers.com>
Co-authored-by: Chris Mc <prince.chrismc@gmail.com>
2022-10-06 18:06:26 +02:00
Chris Mc
304d808ff7 (#12687) docs: spelling and formatting 2022-08-30 14:04:33 +02:00
Chris Mc
8432383343 (#11656) Documented missing errors from knowledge base
* Documented missing errors from knowledge base

* Update docs/error_knowledge_base.md

Co-authored-by: Ryan Thornton <thorntonryan@johndeere.com>

* Update docs/error_knowledge_base.md

Co-authored-by: SSE4 <tomskside@gmail.com>

* Update docs/error_knowledge_base.md

* Update error_knowledge_base.md

* attempt at summarizing "MANDATORY SETTINGS"

* add a better example for tool recipes

plus call out scripts recipes since thats a thing 🙈

* Update docs/error_knowledge_base.md

replace make with cmake because I can not read

* Update docs/error_knowledge_base.md

* Update docs/error_knowledge_base.md

* remove build script packages, too many exceptions

these are exceptional and probably a case by base is required

* note options with header only

Co-authored-by: Ryan Thornton <thorntonryan@johndeere.com>
Co-authored-by: SSE4 <tomskside@gmail.com>
2022-08-04 09:23:20 +02:00
Chris Mc
dada12fef9 (#11720) docs: What to do when there is a custom license
* docs: what to do when there is a custom license

this came up in #11121 and I am trying to capture the information

* link hook rules to FAQ

* also put it in the faq

* relative link same as #10639

* Update reviewing.md
2022-07-18 13:42:31 +02:00
Javier G. Sogo
10aad63663 (#10639) docs: use relative links 2022-05-08 15:45:07 +02:00
SSE4
8d598fffe1 (#9408) - add KB-H065 & KB-H066, clarify some points and add relevant links for newcomers
Signed-off-by: SSE4 <tomskside@gmail.com>
2022-02-27 18:47:50 +01:00
SSE4
31441eddce (#7643) - [KB-H047] deprecated (non-ascii) - Python 3+ is fully Unicode-aware
Signed-off-by: SSE4 <tomskside@gmail.com>
2021-10-12 01:32:27 +02:00
Uilian Ries
02222ff817 (#7381) Introduce KB 057 on documentation
Signed-off-by: Uilian Ries <uilianries@gmail.com>
2021-09-23 09:02:32 +02:00
Anonymous Maarten
e3db70c116 (#7235) Document KB-H062 and KB-H064 2021-09-10 23:32:52 +02:00
Gökhan Karabulut
4e31177990 (#6760) Fix generator name in error knowledge base
We don't have a `cmake_find_multi_package` generator. Rename it to
`cmake_find_package_multi`.
2021-08-10 21:32:02 +02:00
Uilian Ries
a93df8fab6 (#6136) [docs] Update Error Knowledge Base
* Update Error Knowledge Base

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Update docs/error_knowledge_base.md

Co-authored-by: Michael Keck <git@cr0ydon.com>

Co-authored-by: Michael Keck <git@cr0ydon.com>
2021-07-05 19:32:25 +02:00
Uilian Ries
62c09bfb04 (#5002) KB-H007 Remove fPIC when building shared lib 2021-03-23 09:31:44 +01:00
SSE4
d0c135fa48 (#2662) - docs for KB-H053
* - docs for KB-H053

Signed-off-by: SSE4 <tomskside@gmail.com>

* Update docs/error_knowledge_base.md

Co-authored-by: Michael "Croydon" Keck <git@cr0ydon.com>

* Update docs/error_knowledge_base.md

Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>

Co-authored-by: Michael "Croydon" Keck <git@cr0ydon.com>
Co-authored-by: jgsogo <jgsogo@gmail.com>
2020-10-14 06:01:52 +02:00
Javier G. Sogo
e448c74c9a add KB053 (#2935) 2020-09-16 16:52:28 +02:00
SSE4
d82dadd34f - add doc for KB-H052 (#2640)
Signed-off-by: SSE4 <tomskside@gmail.com>
2020-08-25 13:31:37 +02:00
Daniel
483ed32c9c Merge pull request #2593 from uilianries/docs/hook-kb-h049
Add KB-H049 to docs
2020-08-21 09:48:34 +02:00
Javier G. Sogo
4c9003ac8a Add docs about default_options (#2626) 2020-08-20 16:57:57 +02:00
Daniel
3f4011b15e Merge branch 'master' into docs/hook-kb-h049 2020-08-19 17:30:31 +02:00
Uilian Ries
f1d71a0e82 Add KB-H050 description
Signed-off-by: Uilian Ries <uilianries@gmail.com>
2020-08-19 10:43:18 -03:00
Uilian Ries
58c67ca005 Add WINDOWS_EXPORT_ALL_SYMBOLS to KB-H049 description
Signed-off-by: Uilian Ries <uilianries@gmail.com>
2020-08-18 13:15:11 -03:00
Uilian Ries
066df32989 Add KB-H049 to docs
Signed-off-by: Uilian Ries <uilianries@gmail.com>
2020-08-18 12:12:00 -03:00
jgsogo
0677a09cd4 Merge remote-tracking branch 'conan/master' into docs/toc 2020-08-11 14:22:20 +02:00
jgsogo
ad5837b665 change links to docs inside doc folder 2020-08-11 14:08:17 +02:00
jgsogo
69205fd8a3 add TOC to docs folder 2020-08-11 14:00:33 +02:00
Uilian Ries
339c1eefc3 Add KB-H048 description
Signed-off-by: Uilian Ries <uilianries@gmail.com>
2020-07-27 15:24:51 -03:00
Uilian Ries
ee0576a927 Copy Wiki content to docs
Signed-off-by: Uilian Ries <uilianries@gmail.com>
2020-07-23 15:26:33 -03:00