add developer documentation about environment setup #51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dirk-thomas
force-pushed
the
dirk-thomas/environment-setup
branch
from
18eddb6 to
687dd40
Compare
dirk-thomas
force-pushed
the
dirk-thomas/environment-setup
branch
from
687dd40 to
7af88c6
Compare
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
reviewed
Nov 5, 2019
maryaB-osr
approved these changes
Nov 5, 2019
Co-Authored-By: Marya Belanger <[email protected]>
|
@maryaB-osr Thanks for the improvements! I just removed two extra spaces in 4753935. |
mikepurvis
reviewed
Nov 11, 2019
mikepurvis
reviewed
Nov 11, 2019
developer/environment.rst
Outdated
|
|
||
| Therefore both parts are implemented in a Python script located in the root of the install prefix: ``_local_setup_util_<ext>.py``. | ||
| While the Python script itself can't change the environment it is able to efficiently interpret the operations described by the ``.dsv`` files and generate the shell specific commands necessary to update the environment. | ||
| The Python file is templated with information specific to the primary shell it used from hence the ``<ext>`` in the filename. |
There was a problem hiding this comment.
Rationale for templating out multiple instances of the script rather than just passing arguments to one?
There was a problem hiding this comment.
The templated approach was just easier to implement. The script logic only needs to take one set of formatting strings into account.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on questions in colcon/colcon-core#262.