Skip to content

Commit 25c76a6

Browse files
authored
#265: Correction in IDEasy-usage.adoc (#266)
Repair the links for projects and updates and delete the link for scripts
1 parent 4e9b19b commit 25c76a6

File tree

3 files changed

+49
-2
lines changed

3 files changed

+49
-2
lines changed

documentation/IDEasy-usage.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ include::conf.adoc[leveloffset=3]
2424

2525
include::log.adoc[leveloffset=3]
2626

27-
include::scripts.adoc[leveloffset=3]
28-
2927
include::settings.adoc[leveloffset=3]
3028

3129
include::software.adoc[leveloffset=3]

documentation/projects.adoc

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
:toc:
2+
toc::[]
3+
4+
= Project import
5+
6+
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:
7+
8+
[source, properties]
9+
----
10+
path=myproject
11+
workingsets=Set1,Set2
12+
workspace=example
13+
git_url=http://github.com/someorg/someproject
14+
git_branch=develop
15+
build_path=.
16+
build_cmd=mvn -DskipTests=true -Darchetype.test.skip=true clean install
17+
eclipse=import
18+
active=true
19+
----
20+
21+
.Variables of project import
22+
[options="header"]
23+
|===
24+
|*Variable*|*Value*|*Meaning*
25+
|`path`|e.g. `myproject`, will clone into `${WORKSPACE_PATH}/myproject`|(required) Path into which the projects is cloned. This path is relative to the workspace.
26+
|`working sets`|e.g. `ws1,ws2`|(optional) This will create working sets (in eclipse). Each module (eclipse project) of this project will be part of all these working sets. Working sets will be automatically created if necessary.
27+
|`workspace`|`main`|Workspace to use for checkout and import. Default is `main`.
28+
|`git_url`|e.g. `http://github.com/someorg/someproject`|(required) Git URL to use for cloning the project.
29+
|`git_branch`|e.g. `develop`|(optional) Git branch to checkout. Git default branch is default.
30+
|`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.
31+
|`build_cmd`
32+
|e.g. `mvn -D skip Tests=true -Darchetype.test.skip=true clean install`
33+
|(optional) The _devonfw_ command to invoke to build the project after clone or pull. If omitted no build is triggered.
34+
|`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.
35+
|`active`|`true`|(optional) If set to `false` the project is skipped during the link:setup.asciidoc[setup].
36+
|===
37+
38+
Please note that the `.properties` file is parsed via shell and not via java. So be careful with "advanced" features `.properties` files normally support.

documentation/updates.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:toc:
2+
toc::[]
3+
4+
= updates
5+
6+
The `updates` folder is used for temporary data. This includes:
7+
8+
* extracted archives for installation and updates
9+
* backups of old content on updates to prevent data loss
10+
11+
If all works fine you may clean this folder to save some kilo- or mega-bytes. Otherwise, you can ignore it unless you are looking for a backup after a failed or unplanned upgrade.

0 commit comments

Comments
 (0)