Skip to content

Commit 595e5c3

Browse files
committed
docs: Expand ~/.ui5 disk space troubleshooting section
Add build cache and SSL certificate entries to the data directory table, cross-link Builder.md cache info, and note custom data dir configuration.
1 parent 11406ee commit 595e5c3

2 files changed

Lines changed: 25 additions & 3 deletions

File tree

internal/documentation/docs/pages/Builder.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,8 @@ In this scenario, when a source file is changed, always perform a full rebuild,
219219

220220
::: info
221221
By default, the build cache is stored inside UI5 CLI's Data Dir (`~/.ui5/buildCache/`). You can customize the location (see [Changing UI5 CLI's Data Directory](./Troubleshooting#changing-ui5-cli-s-data-directory)).
222+
223+
The cache may grow over time. It can be deleted at any time to reclaim disk space — it will be rebuilt on the next `ui5 build` or `ui5 serve` run. See [`~/.ui5` Taking too Much Disk Space](./Troubleshooting.md#ui5-taking-too-much-disk-space).
222224
:::
223225

224226
::: info

internal/documentation/docs/pages/Troubleshooting.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,37 @@ Please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/main
1212
## UI5 Project
1313
### `~/.ui5` Taking too Much Disk Space
1414

15-
There are possibly many versions of UI5 framework dependencies installed on your system, taking a large amount of disk space.
15+
UI5 CLI stores several kinds of data under your user's home directory in `~/.ui5/`:
16+
17+
| Directory | Contents | Safe to delete? |
18+
| ---- | ---- | ---- |
19+
| `~/.ui5/framework/` | Downloaded UI5 framework dependencies (one copy per version) | Yes — re-downloaded on next invocation |
20+
| `~/.ui5/buildCache/` | Build cache used by `ui5 build` and `ui5 serve` (see [Build Cache Control](./Builder.md#build-cache-control)) | Yes — rebuilt on next `ui5 build` / `ui5 serve` |
21+
| `~/.ui5/server/` | Locally generated SSL certificate and private key for HTTPS / HTTP/2 mode | Yes — regenerated on next HTTPS server start; the new certificate must be re-trusted |
22+
23+
::: warning
24+
Only remove these directories when no UI5 CLI process and no `@ui5/*` API consumer is actively running. Deleting files that are in use can cause running builds or servers to fail or produce inconsistent results.
25+
:::
1626

1727
#### Resolution
1828

19-
Remove the `.ui5/framework/` directory from your user's home directory:
29+
To free disk space, remove the relevant subdirectory.
30+
31+
To only remove framework downloads:
2032

2133
```sh
2234
rm -rf ~/.ui5/framework/
2335
```
2436

25-
Any missing framework dependencies will be downloaded again during the next UI5 CLI invocation.
37+
To only remove the build cache:
38+
39+
```sh
40+
rm -rf ~/.ui5/buildCache/
41+
```
42+
43+
::: info
44+
If you have configured a custom data directory via `UI5_DATA_DIR` or `ui5 config set ui5DataDir`, replace `~/.ui5/` with that path. See [Changing UI5 CLI's Data Directory](#changing-ui5-cli-s-data-directory).
45+
:::
2646

2747
## Environment Variables
2848
### Changing the Log Level

0 commit comments

Comments
 (0)