Skip to content

Add note about editable package pitfall (#4749) #1247

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add note about editable package pitfall (#4749) #1247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions developing_packages/editable_packages.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,12 @@ time, without any Conan command.

When a package is in editable mode, most of the commands will not work. It is not possible to :command:`conan upload`,
:command:`conan export` or :command:`conan create` when a package is in editable mode.

.. note::

CMake-based consumer projects may not pick up on modifications made to header files in the editable package. In this
Copy link
Member

Choose a reason for hiding this comment

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

I think this behavior is not specific to CMake, but any build system and working with editable packages

Copy link
Member

Choose a reason for hiding this comment

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

I mean, this is the normal (maybe not expected at first try) behavior

Copy link
Author

Choose a reason for hiding this comment

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

That's entirely fair, it's just that I offered to add a note in the documentation in the linked Conan issue.

I think it's enough of a potential trip-up that I figured it could save people troubleshooting time if one would point this out up-front. But feel free to close the PR if you don't think that's necessary.

Copy link
Member

Choose a reason for hiding this comment

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

I think the note is fine, just make it more generic (it doesn't happen only with header libraries but any other library as well) and is not specific to CMake

case, a full rebuild is necessary to pick up on the changes in the package's source files. Using :ref:`workspaces`
may provide a better workflow in this specific case.

Revert the editable mode
------------------------
Expand Down