add mentioning k4_local_repo
#87
Open
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
tmadlener
reviewed
Jan 16, 2025
There was a problem hiding this comment.
Good idea. Thanks. The limitations sound rather horrifying at the moment ;) We could think about adding a sentence, that mentions that all the manual steps can also be put into a script, but I don't know if that doesn't encourage the proliferation of some truly horrible scripts...
| `k4_local_repo` is a helper command to simplify setting up the environment for single package development. This command becomes available immediately after sourcing the environment. To use it, navigate to the root directory of the package you want to develop and execute the command: | ||
|
|
||
| ```bash | ||
| k4_local_repo <install_location> |
There was a problem hiding this comment.
Suggested change
| k4_local_repo <install_location> | |
| k4_local_repo [<install_location>] |
To indicate it's optional and defaults to install?
| export PYTHONPATH=<install_location>/python:$PYTHONPATH | ||
| ``` | ||
|
|
||
| where `<install_location>` should match the install location specified during cmake configuration with `-DCMAKE_INSTALL_PREFIX=<install_location>`. It's possible some packages may required specifying some extra environmental variables beside these. |
There was a problem hiding this comment.
Suggested change
| where `<install_location>` should match the install location specified during cmake configuration with `-DCMAKE_INSTALL_PREFIX=<install_location>`. It's possible some packages may required specifying some extra environmental variables beside these. | |
| where `<install_location>` should match the install location specified during cmake configuration with `-DCMAKE_INSTALL_PREFIX=<install_location>`. It's possible some packages may require specifying some extra environmental variables beside these. |
Should we also mention MARLIN_DLL here? It's also done automatically in some cases by k4_local_repo.
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.
BEGINRELEASENOTES
k4_local_repoENDRELEASENOTES
Updating the single package development docs to recommend the usage of
k4_local_repo