Skip to content

Commit f1da1d7

Browse files
authored
Fix typos in Build garbage collection manual
1 parent c818356 commit f1da1d7

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

content/manuals/build/cache/garbage-collection.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The default GC policies are (approximately):
5757
been used for more than 48 hours.
5858
2. Remove cache that hasn't been used in a build for more than 60 days.
5959
3. Remove unshared cache that exceeds the build cache size limit. Unshared
60-
cache records refers to layer blobs that are not used by other resources
60+
cache records refer to layer blobs that are not used by other resources
6161
(typically, as image layers).
6262
4. Remove any build cache that exceeds the build cache size limit.
6363

@@ -69,7 +69,7 @@ depending on what kind of builder you're using. Refer to
6969

7070
> [!NOTE]
7171
> If you're satisfied with the default garbage collection behavior and don't
72-
> need to fine-tune its settings, you can skip this section. Default
72+
> need to fine-tune its settings, you can skip this section. The default
7373
> configurations work well for most use cases and require no additional setup.
7474
7575
Depending on the type of [build driver](../builders/drivers/_index.md) you use,
@@ -137,16 +137,16 @@ default GC policies resolve to:
137137
The easiest way to tweak the build cache configuration for the `docker` driver
138138
is to adjust the `defaultKeepStorage` option:
139139

140-
- Increase the limit if you feel like you think the GC is too aggressive.
140+
- Increase the limit if you feel like the GC is too aggressive.
141141
- Decrease the limit if you need to preserve space.
142142

143143
If you need even more control, you can define your own GC policies directly.
144144
The following example defines a more conservative GC configuration with the
145145
following policies:
146146

147-
1. Remove unused cache entries older than 1440 hours, or 60 days, if build cache exceeds 50GB.
148-
2. Remove unshared cache entries if build cache exceeds 50GB.
149-
3. Remove any cache entries if build cache exceeds 100GB.
147+
1. Remove unused cache entries older than 1440 hours, or 60 days, if the build cache exceeds 50GB.
148+
2. Remove unshared cache entries if the build cache exceeds 50GB.
149+
3. Remove any cache entries if the build cache exceeds 100GB.
150150

151151
```json
152152
{
@@ -180,7 +180,7 @@ tweak the thresholds for how much disk space BuildKit should use for cache:
180180
| `maxUsedSpace` | The maximum amount of disk space that BuildKit is allowed to use. Usage above this threshold will be reclaimed during garbage collection. | 60% of total disk space or 100GB (whichever is lower) |
181181
| `minFreeSpace` | The amount of disk space that must be kept free. | 20GB |
182182

183-
You can set these options either as number of bytes, a unit string (for
183+
You can set these options either as a number of bytes, a unit string (for
184184
example, `512MB`), or as a percentage of the total disk size. Changing these
185185
options influences the default GC policies used by the BuildKit worker. With
186186
the default thresholds, the GC policies resolve as follows:
@@ -245,14 +245,14 @@ policy is allowed to prune.
245245

246246
#### Custom GC policies in BuildKit
247247

248-
Custom GC policies let you fine-tune how BuildKit manages its cache, and gives
248+
Custom GC policies let you fine-tune how BuildKit manages its cache, and give
249249
you full control over cache retention based on criteria such as cache type,
250250
duration, or disk space thresholds. If you need full control over the cache
251251
thresholds and how cache records should be prioritized, defining custom GC
252252
policies is the way to go.
253253

254254
To define a custom GC policy, use the `[[worker.oci.gcpolicy]]` configuration
255-
block in `buildkitd.toml`. Each policy define the thresholds that will be used
255+
block in `buildkitd.toml`. Each policy defines the thresholds that will be used
256256
for that policy. The global values for `reservedSpace`, `maxUsedSpace`, and
257257
`minFreeSpace` do not apply if you use custom policies.
258258

@@ -280,7 +280,7 @@ Here’s an example configuration:
280280
maxUsedSpace = "90GB"
281281
```
282282

283-
In addition to the `reservedSpace`, `maxUsedSpace`, and `minFreeSpace` threshold,
283+
In addition to the `reservedSpace`, `maxUsedSpace`, and `minFreeSpace` thresholds,
284284
when defining a GC policy you have two additional configuration options:
285285

286286
- `all`: By default, BuildKit will exclude some cache records from being pruned

0 commit comments

Comments
 (0)