diff --git a/documentation/projects.asciidoc b/documentation/projects.asciidoc index 734152dd7..8b53e094e 100644 --- a/documentation/projects.asciidoc +++ b/documentation/projects.asciidoc @@ -3,9 +3,7 @@ toc::[] = Project import -`IDEasy` supports to automatically check out and import required git repositories (with your source code) into your IDE during link:setup.asciidoc[setup]. -To configure this you put a `.properties` file for each desired project into the `repositories` sub-folder in your link:settings.asciidoc[settings]. -Each `.properties` file describes one "repository" which you would like to check out and (potentially) import: +The `devonfw-ide` supports to automatically check out and import required projects into your IDE during link:setup.asciidoc[setup]. To configure this you put a `.properties` file for each desired project into the `projects` sub-folder in your link:settings.asciidoc[settings]. Each `.properties` file describes one "project" which you would like to check out and (potentially) import: [source, properties] ---- @@ -30,8 +28,11 @@ active=true |`git_url`|e.g. `http://github.com/someorg/someproject`|(required) Git URL to use for cloning the project. |`git_branch`|e.g. `develop`|(optional) Git branch to checkout. Git default branch is default. |`build_path`|e.g. `.` (default)|(optional) The directory inside `path` where to trigger an initial build after clone or pull (if `build_cmd` is set). For a regular project use `.` to build top-level project. -|`build_cmd` |e.g. `mvn -D skip Tests=true -Darchetype.test.skip=true clean install` |(optional) The _devonfw_ command to invoke to build the project after clone or pull. If omitted no build is triggered. +|`build_cmd` +|e.g. `mvn -D skip Tests=true -Darchetype.test.skip=true clean install` +|(optional) The _devonfw_ command to invoke to build the project after clone or pull. If omitted no build is triggered. |`eclipse`|e.g. `import`|(optional) Desired action for eclipse IDE. If you put `import` here all modules (eclipse projects) in the current project will be imported into eclipse. If you leave this out or put any other value for this parameter, no change in eclipse is done. |`active`|`true`|(optional) If set to `false` the project is skipped during the link:setup.asciidoc[setup]. |=== +Please note that the `.properties` file is parsed via shell and not via java. So be careful with "advanced" features `.properties` files normally support.