docs: more context around shm-size and ulimit usage

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
docker · Feb 14, 2024 · d11b1da · d11b1da
1 parent 03edd08
commit d11b1da
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/docs/bake-reference.md b/docs/bake-reference.md
@@ -836,6 +836,9 @@ RUN --mount=type=secret,id=KUBECONFIG \
 
 ### `target.shm-size`
 
+Sets the size of the shared memory allocated for build's containers when using
+`RUN` instructions.
+
 The format is `<number><unit>`. `number` must be greater than `0`. Unit is
 optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g`
 (gigabytes). If you omit the unit, the system uses bytes.
@@ -896,7 +899,8 @@ target "default" {
 
 ### `target.ulimits`
 
-Ulimits are specified with a soft and hard limit as such:
+Ulimits overrides the default ulimits of build's containers when using `RUN`
+instructions and are specified with a soft and hard limit as such:
 `<type>=<soft limit>[:<hard limit>]`, for example:
 
 ```hcl

diff --git a/docs/reference/buildx_build.md b/docs/reference/buildx_build.md
@@ -655,6 +655,9 @@ $ SECRET_TOKEN=token docker buildx build --secret id=SECRET_TOKEN .
 
 ### <a name="shm-size"></a> Size of /dev/shm (--shm-size)
 
+Sets the size of the shared memory allocated for build's containers when using
+`RUN` instructions.
+
 The format is `<number><unit>`. `number` must be greater than `0`. Unit is
 optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g`
 (gigabytes). If you omit the unit, the system uses bytes.
@@ -692,7 +695,8 @@ $ docker buildx build --ssh default=$SSH_AUTH_SOCK .
 
 ### <a name="ulimit"></a> Set ulimits (--ulimit)
 
-`--ulimit` is specified with a soft and hard limit as such:
+`--ulimit` overrides the default ulimits of build's containers when using `RUN`
+instructions and are specified with a soft and hard limit as such:
 `<type>=<soft limit>[:<hard limit>]`, for example:
 
 ```console