Skip to content

Commit 0bada32

Browse files
authored
Some fixes in editable packages (conan-io#1337)
* Fixes * using they * Fix broken link
1 parent 9076f66 commit 0bada32

File tree

2 files changed

+12
-14
lines changed

2 files changed

+12
-14
lines changed

developing_packages/editable_packages.rst

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Packages in editable mode
77

88
This is an **experimental** feature subject to breaking changes in future releases.
99

10-
When working in big projects with several functionalities interconnected it is recomended to avoid
11-
the one-and-only huge project approach in favor of several libraries each one of them specialized
10+
When working in big projects with several functionalities interconnected it is recommended to avoid
11+
the one-and-only huge project approach in favor of several libraries, each one specialized
1212
in a set of common tasks, even maintained by dedicated teams. This approach helps to isolate
13-
and reuse code, helps with compiling times and reduces the likelihood of including files that
13+
and reusing code helps with compiling times and reduces the likelihood of including files that
1414
not correspond to the API of the required library.
1515

1616
Nevertheless, in some case, it is useful to work in several libraries at the same time and see how
@@ -21,16 +21,14 @@ get the changes ready for a consumer library, it is needed the :command:`conan c
2121
actually trigger a build to generate the binaries in the cache or to run :command:`conan export-pkg`
2222
to copy locally built artifacts into the conan cache and make them available to consumers.
2323

24-
What about if you just can tell Conan where to find the headers and the artifacts ready for
25-
consumption in your local working directory? No need to package, just tell Conan to use those
26-
artifacts you have just generated with your IDE, sounds good? This is what the feature
27-
*editable packages* will do for you.
24+
With the editable packages, you can tell Conan where to find the headers and the artifacts ready for
25+
consumption in your local working directory. There is no need to package.
2826

2927
Let's see this feature over an example where a developer is creating a ``CoolApp`` but at the same
30-
time they wants to work on ``cool/version@user/dev`` library which is tightly coupled to the app.
28+
time they want to work on ``cool/version@user/dev`` library which is tightly coupled to the app.
3129

3230
The package ``cool/version@user/dev`` is already working, the developer has the sources in a
33-
local folder, they is using whatever method to build and develop locally and can perform
31+
local folder and they are using whatever method to build and develop locally and can perform
3432
a :command:`conan create . cool/version@user/dev` to create the package.
3533

3634
Also, there is a *conanfile.txt* (or a more complex recipe) for the application ``CoolApp`` that
@@ -47,14 +45,14 @@ working directory**:
4745
.. code-block:: bash
4846
4947
$ conan editable add <path/to/local/dev/libcool> cool/version@user/dev
50-
# you could do cd <path/to/local/dev/libcool> && conan editable add . cool/version@user/dev
48+
# you could do "cd <path/to/local/dev/libcool> && conan editable add . cool/version@user/dev"
5149
5250
53-
That is it. Now, every usage of ``cool/version@user/dev``, by any other Conan package, or project
54-
will be redirected to the ``<path/to/local/dev/libcool>`` user folder, instead of using the package
51+
That is it. Now, every usage of ``cool/version@user/dev``, by any other Conan package or project,
52+
will be redirected to the ``<path/to/local/dev/libcool>`` user folder instead of using the package
5553
from the conan cache.
5654

57-
Conan package recipes define a package "layout" in their ``package_info()`` methods. The default one,
55+
The Conan package recipes define a package "layout" in their ``package_info()`` methods. The default one,
5856
if nothing is specified is equivalent to:
5957

6058
.. code-block:: python

integrations/ide/youcompleteme.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
YouCompleteMe (vim)
44
-------------------
55

6-
If you are a vim user, you may also be a user of `YouCompleteMe <http://valloric.github.io/YouCompleteMe/>`_.
6+
If you are a vim user, you may also be a user of `YouCompleteMe <https://github.com/ycm-core/YouCompleteMe/>`_.
77

88
With this generator, you can create the necessary files for your project dependencies, so YouCompleteMe
99
will show symbols from your Conan installed dependencies for your project.

0 commit comments

Comments
 (0)