Skip to content

Commit

Permalink
fix layout() source folder description (conan-io#2867)
Browse files Browse the repository at this point in the history
* fix layout() source folder description

* Update reference/conanfile/methods.rst

Co-authored-by: Rubén Rincón Blanco <[email protected]>

Co-authored-by: Rubén Rincón Blanco <[email protected]>
  • Loading branch information
memsharded and AbrilRBS authored Dec 22, 2022
1 parent 357861e commit 3339ceb
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions reference/conanfile/methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1581,11 +1581,9 @@ self.folders


- **self.folders.source** (Defaulted to ""): Specifies a subfolder where the sources are. The ``self.source_folder`` attribute
inside the ``source(self)`` and ``build(self)`` methods will be set with this subfolder. But the *current working directory*
in the ``source(self)`` method will not include this subfolder, because it is intended to describe where the sources are after
downloading (zip, git...) them, not to force where the sources should be. As well, the `export_sources`, `exports` and `scm` sources
will be copied to the root source directory, being the **self.folders.source** variable the way to describe if the fetched sources
are still in a subfolder.
inside the ``source(self)`` and ``build(self)`` methods will be set with this subfolder. The *current working directory*
in the ``source(self)`` method will include this subfolder. The `export_sources`, `exports` and `scm` sources
will also be copied to the root source directory.
It is used in the cache when running
:command:`conan create` (relative to the cache source folder) as well as in a local folder when running :command:`conan build`
(relative to the local current folder).
Expand Down

0 comments on commit 3339ceb

Please sign in to comment.