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 for full_transitive_package_id #1575

Merged

Conversation

memsharded
Copy link
Member

@memsharded memsharded commented Mar 3, 2020

creating_packages/define_abi_compatibility.rst Outdated Show resolved Hide resolved
creating_packages/define_abi_compatibility.rst Outdated Show resolved Hide resolved
creating_packages/define_abi_compatibility.rst Outdated Show resolved Hide resolved
creating_packages/define_abi_compatibility.rst Outdated Show resolved Hide resolved
reference/config_files/conan.conf.rst Show resolved Hide resolved
@jgsogo jgsogo requested a review from czoido Mar 4, 2020
@jgsogo
Copy link
Member

jgsogo commented Mar 4, 2020

I'm asking @czoido to review it too. It is needed that someone that hasn't been involved in the PRs understands this piece of docs

@jgsogo
Copy link
Member

jgsogo commented Mar 6, 2020

@memsharded , have a look at the review and merge develop to fix the broken CI

@czoido , please, review the docs, how a newcomer to Conan will read about this (with/without this flag activated)?

@jgsogo jgsogo added this to the 1.23 milestone Mar 6, 2020
@memsharded
Copy link
Member Author

memsharded commented Mar 6, 2020

Added a infographic and improved the text. I think it should be more understandable now.

danimtb
danimtb approved these changes Mar 6, 2020
creating_packages/define_abi_compatibility.rst Outdated Show resolved Hide resolved
jgsogo
jgsogo approved these changes Mar 6, 2020
@czoido
Copy link
Contributor

czoido commented Mar 6, 2020

The image preview looks like this for me... 🤔Is it just my screen? (Macbook retina)

image

memsharded and others added 2 commits Mar 6, 2020
Co-Authored-By: Daniel <danimanzaneque@gmail.com>
Co-Authored-By: Carlos Zoido <mrgalleta@gmail.com>
@memsharded memsharded merged commit 0a2c63b into conan-io:develop Mar 6, 2020
2 checks passed
@memsharded memsharded deleted the feature/full_transitive_package_id branch Mar 6, 2020
- ``App/1.0`` depends on ``PkgC/1.0`` and ``PkgA/1.0``
- ``PkgC/1.0`` depends only on ``PkgB/1.0``
- ``PkgB/1.0`` depends on ``PkgA/1.0``, and defines ``self.info.header_only()`` in its ``package_id()``
- We are using ``full_version_mode``
Copy link
Contributor

@czoido czoido Mar 6, 2020

Choose a reason for hiding this comment

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

I would move this to the line 722: "Lets say that we have the following scenario where we are using full_version_mode:"

@czoido
Copy link
Contributor

czoido commented Mar 6, 2020

In my humble opinion, if the point of the section is to explain the propagation of the packageID and what full_transitive_package_id does I would put an example where App does not depend on PkgA directly to explain thefull_transitive_package_id and then, after this, putting explaining what could happen if it depended from PkgA directly as well. I felt that a little bit confusing at first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants