Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update picking sources and unify with patching rules #14377

Merged

Conversation

prince-chrismc
Copy link
Contributor

Docs!

This is the next installment of #13673 -- it's a bit bigger as I've improved some of the language trying to reflect what's currently happening in CCI

  • I moved the "selecting versions" to the "select sources" i feel those are the same principals.
  • I worked the "picking sources" so it's not just bullet points
  • add how to's

I did not touch the patching rules and exceptions as those deserve their own PR I will not accept suggestions to those please make a seperate PR 🙏


they change the behavior of the library and it will no longer match the
documentation or the changelog originally delivered by the authors.

However, ConanCenter DOES accept **working software patches**, these patches
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe, working software needs some strict definition. as it might be too subjective what is considered working or non-working.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree -- I think it's worth revisiting this to more accurately capture the types of patches we have been seeing since this policy came out :)


## Policy about patching

The main guideline in ConanCenter is to provide already compiled binaries for a set of architectures in the least surprising way as possible, so Conan
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe, least surprising way needs some strict definition. it's not clear for newcomer what exactly does it mean.

franramirez688
franramirez688 previously approved these changes Nov 23, 2022
Copy link
Contributor

@franramirez688 franramirez688 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good to me! As usual, only a few suggestions. Well done! 👏

docs/adding_packages/sources_and_patches.md Outdated Show resolved Hide resolved
docs/adding_packages/conandata_yml_format.md Outdated Show resolved Hide resolved
docs/adding_packages/sources_and_patches.md Outdated Show resolved Hide resolved
docs/adding_packages/sources_and_patches.md Outdated Show resolved Hide resolved
docs/adding_packages/sources_and_patches.md Outdated Show resolved Hide resolved
docs/adding_packages/sources_and_patches.md Outdated Show resolved Hide resolved
docs/adding_packages/sources_and_patches.md Outdated Show resolved Hide resolved
docs/adding_packages/sources_and_patches.md Outdated Show resolved Hide resolved
docs/developing_recipes_locally.md Outdated Show resolved Hide resolved
Co-authored-by: Francisco Ramírez <[email protected]>
Co-authored-by: SSE4 <[email protected]>
@conan-center-bot conan-center-bot merged commit 97b1986 into conan-io:master Nov 25, 2022
prince-chrismc pushed a commit to prince-chrismc/conan-center-index that referenced this pull request Nov 29, 2022
conan-center-bot pushed a commit that referenced this pull request Dec 2, 2022
* 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 <[email protected]>

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: prince-chrismc <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants