Skip to content

Commit 20d987e

Browse files
dcermakDmitri Popov
andauthored
Apply suggestions from code review
Co-authored-by: Dmitri Popov <dmpop@cameracode.coffee>
1 parent 2076e26 commit 20d987e

1 file changed

Lines changed: 14 additions & 18 deletions

File tree

src/bci_build/package/osc/README.md.j2

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
{% include 'badges.j2' %}
44

5-
This is the openSUSE packaging container image, it includes all the necessary
6-
software to create and modify packages in the [Open Build
5+
This is the openSUSE packaging container image that includes all the required
6+
tools for creating and modifying packages in the [Open Build
77
Service](https://build.opensuse.org/) using
88
[osc](https://github.com/openSUSE/osc/).
99

1010

1111
## How to use this container image
1212

13-
This container image is intended for interactive usage with your `.oscrc` and
13+
The container image is intended for interactive usage with a `.oscrc` configuration file and
1414
the osc cookiejar mounted into the container:
1515

1616
```ShellSession
@@ -20,8 +20,7 @@ the osc cookiejar mounted into the container:
2020
{{ image.pretty_reference }}
2121
```
2222

23-
The above command launches an interactive shell where your local osc config will
24-
be used. You can then proceed to checkout packages, perform modifications and
23+
The command launches an interactive shell environment that uses the local osc configuration. You can then check out packages, perform modifications, and
2524
send submissions to OBS.
2625

2726
To work on an already checked out package, mount the current working directory:
@@ -35,8 +34,8 @@ To work on an already checked out package, mount the current working directory:
3534
```
3635

3736
The container entrypoint recognizes whether you are launching it for interactive
38-
usage or whether you are invoking `osc` directly. For convenience, you can omit
39-
the command `osc` in the second case. E.g.:
37+
usage or invoking `osc` directly. You can omit
38+
the command `osc` in the second case. For example:
4039

4140
```ShellSession
4241
# podman run --rm -it \
@@ -45,24 +44,22 @@ the command `osc` in the second case. E.g.:
4544
{{ image.pretty_reference }} ls openSUSE:Factory
4645
```
4746

48-
The above command will automatically forward the arguments to `osc` and call
47+
The command automatically forwards the arguments to `osc` and calls
4948
`osc ls openSUSE:Factory`.
5049

5150

5251
### Using the image labels
5352

54-
The image provides two labels `run` and `runcwd` which include the full command
55-
to run the `osc` container or run it with the local working directory mounted as
56-
well.
53+
The image provides two labels: `run` and `runcwd`. The first includes the full command, to run the `osc` container, while the second to run the container with the local working directory mounted.
5754

58-
These labels can be shown via:
55+
To view the labels, use the following command:
5956

6057
```ShellSession
6158
# podman container runlabel run --display {{ image.pretty_reference }}
6259
# podman container runlabel runcwd --display {{ image.pretty_reference }}
6360
```
6461

65-
The labels can be used to run the container with podman version 5.1.0 or later:
62+
The labels can be used to run the container with Podman version 5.1.0 or later:
6663
```ShellSession
6764
# podman container runlabel run {{ image.pretty_reference }} \
6865
ls openSUSE:Factory
@@ -71,9 +68,8 @@ The labels can be used to run the container with podman version 5.1.0 or later:
7168

7269
### Connecting to build.suse.de
7370

74-
build.suse.de uses a ssh based authentication and thus requires additional
75-
resources to be available in the container. Additionally, you have to provide
76-
the internal certificate to the container as well:
71+
build.suse.de uses an SSH-based authentication, which requires additional
72+
resources to be available in the container. You also must provide the internal certificate to the container:
7773

7874
```ShellSession
7975
# podman run --rm -it \
@@ -89,8 +85,8 @@ the internal certificate to the container as well:
8985

9086
## Limitations
9187

92-
- It is currently not possible to build packages in a container.
93-
- The `runlabel run` command only works with podman 5.1.0 and newer.
88+
- Currently, it is not possible to build packages in a container.
89+
- The `runlabel run` command only works with Podman 5.1.0 and newer.
9490

9591

9692
## Volumes

0 commit comments

Comments
 (0)