Skip to content

Commit a94fd93

Browse files
committed
docs/bootc-images.md: small rephrasing
I am sensitive to undefined "this"es. They require some extra cognitive work from the reader and may be interpreted in various ways. Hence, replace "this" with a more explicit description. Signed-off-by: Valentin Rothberg <[email protected]>
1 parent 491e131 commit a94fd93

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/bootc-images.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ FROM debian
1515
RUN apt install kernel
1616
```
1717

18-
And get an image compatible with bootc. Supporting this
18+
And get an image compatible with bootc. Supporting any base image
1919
is an eventual goal, however there are a few reasons why
2020
this doesn't yet work. The biggest reason is SELinux
2121
labeling support; the underlying ostree stack currently
@@ -25,7 +25,7 @@ for any derived layers.
2525

2626
# Building bootc compatible base images
2727

28-
As a corollary to this, the build process
28+
As a corollary to base-image limitations, the build process
2929
for generating base images currently requires running
3030
through ostree tooling to generate an "ostree commit"
3131
which has some special formatting in the base image.
@@ -34,7 +34,7 @@ However, the ostree usage is an implementation detail
3434
and the requirement on this will be lifted in the future.
3535

3636
For example, the [rpm-ostree compose image](https://coreos.github.io/rpm-ostree/container/#creating-base-images)
37-
tooling currently streamlines this, operating just
37+
tooling currently streamlines creating base images, operating just
3838
on a declarative input and writing to a registry.
3939

4040
This is how the [Project Sagano](https://github.com/centos/sagano)
@@ -55,8 +55,7 @@ RUN dnf -y install foo && dnf clean all
5555

5656
As an opt-in optimization today, you can also add `ostree container commit`
5757
as part of your `RUN` invocations. This will perform early detection
58-
of some incompatibilities.
59-
60-
However, its usage is not and will never be strictly required.
58+
of some incompatibilities but is not a strict requirement today and will not be
59+
in the future.
6160

6261

0 commit comments

Comments
 (0)