-
Notifications
You must be signed in to change notification settings - Fork 87
#2253: Fix structure and log documentation #2272
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
hohwille
merged 15 commits into
devonfw:main
from
krystynaShatkovska:issue-2253-doc-structure-logs
Aug 18, 2026
Merged
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
9768f81
Fix structure and log documentation (#2253)
krystynaShatkovska ed12f59
Merge branch 'main' into issue-2253-doc-structure-logs
hohwille a377057
Update documentation/tmp.adoc
krystynaShatkovska 38150d6
Update documentation/log.adoc
krystynaShatkovska 0c59639
Update documentation/log.adoc
krystynaShatkovska e3559bf
Update documentation/urls.adoc
krystynaShatkovska 5d185ec
Update documentation/log.adoc
krystynaShatkovska c421460
Update documentation/log.adoc
krystynaShatkovska 56b7ec6
Merge branch 'main' into issue-2253-doc-structure-logs
krystynaShatkovska 5306b57
Merge branch 'main' into issue-2253-doc-structure-logs
krystynaShatkovska 28949f9
constructive review fix
hohwille 5029451
Merge branch 'main' into issue-2253-doc-structure-logs
maybeec 32da16e
Merge branch 'main' into issue-2253-doc-structure-logs
krystynaShatkovska 2074d8e
Merge branch 'main' into issue-2253-doc-structure-logs
hohwille 3cd9369
constructive review: moved CHANGELOG entry to current release
hohwille File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,63 @@ | ||
| :toc: | ||
| toc::[] | ||
|
|
||
| = log | ||
| = Logs | ||
|
|
||
| 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 | ||
|
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. | ||
|
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. | ||
| ==== | ||
|
krystynaShatkovska marked this conversation as resolved.
Outdated
|
||
This file contains hidden or 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
This file contains hidden or 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
| 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. | ||
| ==== | ||
|
krystynaShatkovska marked this conversation as resolved.
Outdated
|
||
This file contains hidden or 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
| 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. | ||
|
krystynaShatkovska marked this conversation as resolved.
Outdated
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.