Skip to content

Commit

Permalink
docs: tiny improvements
Browse files Browse the repository at this point in the history
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
  • Loading branch information
dvdksn committed Jan 25, 2024
1 parent 89bbb62 commit 2471c5b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 11 deletions.
5 changes: 2 additions & 3 deletions docs/buildkitd.toml.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@ of daemon configuration.
The file path is `/etc/buildkit/buildkitd.toml` for rootful mode,
`~/.config/buildkit/buildkitd.toml` for rootless mode.

The following is a complete `buildkitd.toml` configuration example, please
note some configuration is only good for edge cases, please take care of it
carefully.
The following is a complete `buildkitd.toml` configuration example.
Note that some configuration options are only useful in edge cases.

```toml
# debug enables additional debug logging
Expand Down
13 changes: 5 additions & 8 deletions frontend/dockerfile/docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1260,13 +1260,10 @@ doesn't support authentication.
`ADD` obeys the following rules:

- The `<src>` path must be inside the build context;
you can't use `COPY ../something /something`, because the builder can only
you can't use `ADD ../something /something`, because the builder can only
access files from the context, and `../something` specifies a parent file or
directory of the build context root.

- If `<src>` is a directory, the entire contents of the directory are copied,
including filesystem metadata.

- If `<src>` is a URL and `<dest>` does end with a trailing slash, then the
filename is inferred from the URL and the file is downloaded to
`<dest>/<filename>`. For instance, `ADD http://example.com/foobar /` would
Expand Down Expand Up @@ -1308,8 +1305,8 @@ doesn't support authentication.
use of a wildcard, then `<dest>` must be a directory, and it must end with
a slash `/`.

- If `<dest>` doesn't end with a trailing slash, it will be considered a
regular file and the contents of `<src>` will be written at `<dest>`.
- If `<src>` is a file, and `<dest>` doesn't end with a trailing slash,
the contents of `<src>` will be written as filename `<dest>`.

- If `<dest>` doesn't exist, it's created, along with all missing directories
in its path.
Expand Down Expand Up @@ -1487,8 +1484,8 @@ attempted to be used instead.
use of a wildcard, then `<dest>` must be a directory, and it must end with
a slash `/`.

- If `<dest>` doesn't end with a trailing slash, it will be considered a
regular file and the contents of `<src>` will be written at `<dest>`.
- If `<src>` is a file, and `<dest>` doesn't end with a trailing slash,
the contents of `<src>` will be written as filename `<dest>`.

- If `<dest>` doesn't exist, it's created, along with all missing directories
in its path.
Expand Down

0 comments on commit 2471c5b

Please sign in to comment.