Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This file documents all notable changes to https://github.com/devonfw/IDEasy[IDE

Release with new features and bugfixes:

* https://github.com/devonfw/IDEasy/issues/2253[#2253]: Fix structure and log documentation
* https://github.com/devonfw/IDEasy/issues/2187[#2187]: Start SoapUI commandlet in background
* https://github.com/devonfw/IDEasy/issues/2189[#2189]: Integrate Ruff
* https://github.com/devonfw/IDEasy/issues/2126[#2126]: Fix language selection dropdown
Expand Down
61 changes: 59 additions & 2 deletions documentation/log.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,63 @@
:toc:
toc::[]

= log
= Logs
Comment thread
krystynaShatkovska marked this conversation as resolved.
Outdated

The log directory is used to store log files e.g. for the IDE link:configurator.adoc[configurator]. You may look here for debug information if something goes wrong.
The log directory is used to store log files created by IDEasy.

Logs are stored in:

----
$IDE_ROOT/_ide/logs
----

The log directory can be helpful for troubleshooting and debugging if something goes wrong during execution of IDEasy commands.

Typical log files are generated for:

* setup
* update
* install
* uninstall
* upgrade
* build
Comment thread
krystynaShatkovska marked this conversation as resolved.
Outdated

The log directory also stores installation and uninstallation logs of IDEasy itself.

The logs are organized in date-based directories below the `logs` folder.

A typical structure looks similar to:

----
$IDE_ROOT/_ide/logs
└── 2026
└── 08
├── 04
└── 05
----

The first directory level represents the year, followed by the month and day.
This structure helps keeping log files organized by date.
Comment thread
krystynaShatkovska marked this conversation as resolved.
Outdated

Log files contain detailed diagnostic information such as timestamps, log levels, executed operations, warnings, errors, and stack traces.
They are intended for troubleshooting and analysing problems during IDEasy execution.

On the console, the visible log level can be influenced with options such as:

----
ide --debug
ide --trace
ide --quiet
----

However, log files are always written with full trace information to ensure all details required for troubleshooting are available, regardless of the selected console log level.

To remove obsolete data and free disk space, use the `ide cleanup` command.

[NOTE]
====
The `ide cleanup` command is still work in progress (see issue #1580).

Currently it mainly supports cleanup of unused software.
Cleanup of temporary files and logs is planned as a future enhancement.
====
Comment thread
krystynaShatkovska marked this conversation as resolved.
Outdated
6 changes: 3 additions & 3 deletions documentation/structure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ The directory layout of your `IDEasy` will look like this:
| | ├── IDEasy-doc.pdf
| | └── setup[.bat]
| ├──/ link:software.adoc[software]/
| ├──/ tmp/
| └──/ urls/
| ├──/ link:log.adoc[logs]/
| ├──/ link:tmp.adoc[tmp]/
| └──/ link:urls.adoc[urls]/
└──/ link:project.adoc[my-project] (link:variables.adoc[$IDE_HOME])
├──/ link:conf.adoc[conf]/
├──/ link:log.adoc[log]/
├──/ link:settings.adoc[settings]/
├──/ link:software.adoc[software]/
└──/ link:workspaces.adoc[workspaces]/
Expand Down
26 changes: 26 additions & 0 deletions documentation/tmp.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
:toc:
toc::[]

= tmp

The `tmp` directory is located in:

----
$IDE_ROOT/_ide/tmp
----

It is used by IDEasy to store temporary files created during command execution.
Typical examples are temporary extraction folders, intermediate downloads, or files created while installing or updating tools.

Temporary files are not intended to be edited manually.
If IDEasy is interrupted, for example during a download or extraction, temporary files may remain in this directory.

To free disk space, use the `ide cleanup` command once cleanup support for temporary files is available.
The `ide cleanup` command is still work in progress (see issue #1580).

[NOTE]
====
The `ide cleanup` command is still work in progress.
Currently it mainly supports cleanup of unused software.
Cleanup of `tmp` and `logs` is planned as a future enhancement.
====
Comment thread
krystynaShatkovska marked this conversation as resolved.
Outdated
24 changes: 24 additions & 0 deletions documentation/urls.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:toc:
toc::[]

= urls

The `urls` directory is located in:

----
$IDE_ROOT/_ide/urls
----

It contains URL metadata used by IDEasy to resolve download locations for supported tools.
IDEasy uses this data to find versions, editions, platform-specific archives, and download URLs for tools such as Java, Maven, Node.js, IntelliJ, VS Code, and others.

The content of this directory is managed by IDEasy.
You normally do not need to edit files in this folder manually.

If URL metadata is outdated or missing, run:

----
ide update
----

or use the according IDEasy command for the tool you are working with.
Comment thread
krystynaShatkovska marked this conversation as resolved.
Outdated
Loading