Skip to content

Commit 789ac5e

Browse files
bakpaulhugtalbot
andauthored
Apply suggestions from code review
Co-authored-by: Hugo <hugo.talbot@sofa-framework.org>
1 parent 590a3cc commit 789ac5e

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

10_Getting_Started/20_Build/50_Activate_Plugins.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ The activation directives propose two ways of activating those plugins in the bu
2020

2121
### Note on fetched plugins
2222

23-
As stated before, some plugins have their own repository and thus need to e fetched to be compiled in-tree. To do so, you'll need to activate the following flag `SOFA_FETCH_XXX=ON` while replacing `XXX` by the capitalized name of your plugin (note: all '.' in the name shuold be replaced by a '_', e.g. to fetch Sofa.Qt, one need to set the CMake flag `SOFA_FETCH_SOFA_QT=ON`).
23+
As stated before, some plugins have their own repository and thus need to be fetched to be compiled in-tree. To do so, you will need to activate the associated flag `SOFA_FETCH_XXX=ON` (while replacing `XXX` by the capitalized name of your plugin). Note that all '.' in the plugin name should be replaced by a '_', e.g. to fetch Sofa.Qt, one need to set the CMake flag `SOFA_FETCH_SOFA_QT=ON`.
2424

25-
The repository from which to fetch and the tag to checkout can be changed by using the two flags `XXX_GIT_REPOSITORY` and `XXX_GIT_TAG`. The tag can be either a tag, a branch name or a commit hash.
25+
The repository from which to fetch and the tag to checkout can be changed by using the respective flags `XXX_GIT_REPOSITORY` and `XXX_GIT_TAG`. The tag can be either a tag, a branch name or a commit hash.
2626

27-
It has to be noted that you can use a local clone of the repository instead of rely on the fetching mechanism. This can be usefull when you have a version of the plugin on your disk on which you are currently working. To do this, you'll need to make sure `SOFA_FETCH_XXX` is `OFF` and then you can specify the following flag `XXX_LOCAL_DIRECTORY` with an abolute path to the local clone of the plugin.
27+
It should be noted that you can use a local clone of the repository, instead of relying on the fetching mechanism. This can be useful when you have a version of the plugin on your disk on which you are currently working. To do this, you'll need to make sure `SOFA_FETCH_XXX` is `OFF` and then you can specify the flag `XXX_LOCAL_DIRECTORY` with an absolute path to the local clone of the plugin.
2828

29-
No matter what mechanism you use (fetch or local clone) you'll still need to activate it by activating the following CMake flag `{TYPE}_XXX` with type taken into the list `{"APPLICATION", "PLUGIN", "DIRECTORY"}`.
29+
No matter what mechanism you use (fetch or local clone), you will still need to activate it by setting to ON the following CMake flag `{TYPE}_XXX` where TYPE corresponds to one of the following keywords: `{"APPLICATION", "PLUGIN", "DIRECTORY"}`.
3030

3131

0 commit comments

Comments
 (0)