Skip to content

Commit 098f1eb

Browse files
Merge pull request #27055 from Luap99/revert-quadlet-docs
Revert quadlet docs rewrite
2 parents 998c9d8 + 070d7c3 commit 098f1eb

File tree

133 files changed

+2697
-2963
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

133 files changed

+2697
-2963
lines changed

docs/source/markdown/.gitignore

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ podman-manifest-create.1.md
3434
podman-manifest-inspect.1.md
3535
podman-manifest-push.1.md
3636
podman-mount.1.md
37-
podman-network-create.1.md
3837
podman-network-ls.1.md
3938
podman-network-reload.1.md
4039
podman-pause.1.md
@@ -70,11 +69,3 @@ podman-unpause.1.md
7069
podman-update.1.md
7170
podman-volume-ls.1.md
7271
podman-wait.1.md
73-
podman-build.unit.5.md
74-
podman-container.unit.5.md
75-
podman-image.unit.5.md
76-
podman-kube.unit.5.md
77-
podman-kube-down.1.md
78-
podman-network.unit.5.md
79-
podman-pod.unit.5.md
80-
podman-volume.unit.5.md

docs/source/markdown/options/README.md

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ mechanism:
1717

1818
```
1919
@@option foo ! includes options/foo.md
20-
@@option quadlet:foo ! includes options/foo.md with `is_quadlet=True`
21-
! See "Jinja2 Templating" below.
2220
```
2321

2422
The tool that does this is `hack/markdown-preprocess`. It is a python
@@ -27,37 +25,6 @@ file, this script creates a `.md` file that can then be read by
2725
`go-md2man`, `sphinx`, anything that groks markdown. This runs as
2826
part of `make docs`.
2927

30-
Jinja2 Templating
31-
=================
32-
33-
Some options are used as both Podman command line option and Quadlet
34-
option. To reduce the duplication, the Jinja2 templating system can be
35-
used to define parts which should be rendered only in Quadlet man-pages:
36-
37-
```
38-
<< if is_quadlet >>
39-
### `DNS=`
40-
<< else >>
41-
#### **--dns**=*ipaddr*
42-
<< endif >>
43-
```
44-
45-
It is also possible to use in-line condition:
46-
47-
```
48-
<< '**DNS=.**' if is_quadlet else '**--dns**' >>
49-
```
50-
51-
Following variables are available for Jinja2 Templates:
52-
53-
- `is_quadlet`: True if file is imported using `@@option quadlet:foo`.
54-
- `subcommand`: Same as `<<subcommand>>`, see below.
55-
This allows the shared use of examples in the option file:
56-
- `fullcommand`: Same as `<<fullsubcommand>>`, see below.
57-
58-
For more information about Jinja2, check
59-
https://jinja.palletsprojects.com/en/stable/.
60-
6128
Special Substitutions
6229
=====================
6330

docs/source/markdown/options/add-host.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
####> This option file is used in:
2-
####> podman build, podman-container.unit.5.md.in, create, farm build, pod create, podman-pod.unit.5.md.in, run
2+
####> podman build, create, farm build, pod create, run
33
####> If file is edited, make sure the changes
44
####> are applicable to all of those.
5-
<< if is_quadlet >>
6-
### `AddHost=hostname[;hostname[;...]]:ip`
7-
<< else >>
85
#### **--add-host**=*hostname[;hostname[;...]]*:*ip*
9-
<< endif >>
106

117
Add a custom host-to-IP mapping to the <<container|pod>>'s `/etc/hosts` file.
128

docs/source/markdown/options/all-tags.md

Lines changed: 0 additions & 13 deletions
This file was deleted.
Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
####> This option file is used in:
2-
####> podman podman-container.unit.5.md.in, create, kube play, run
2+
####> podman create, kube play, run
33
####> If file is edited, make sure the changes
44
####> are applicable to all of those.
5-
<< if is_quadlet >>
6-
### `Annotation=key=value`
7-
<< else >>
85
#### **--annotation**=*key=value*
9-
<< endif >>
106

117
Add an annotation to the container<<| or pod>>. This option can be set multiple times.

docs/source/markdown/options/annotation.image.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
####> This option file is used in:
2-
####> podman build, podman-build.unit.5.md.in, farm build
2+
####> podman build, farm build
33
####> If file is edited, make sure the changes
44
####> are applicable to all of those.
5-
<< if is_quadlet >>
6-
### `Annotation=annotation=value [annotation=value ...]`
7-
<< else >>
85
#### **--annotation**=*annotation=value*
9-
<< endif >>
106

117
Add an image *annotation* (e.g. annotation=*value*) to the image metadata. Can
128
be used multiple times.
Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
####> This option file is used in:
2-
####> podman podman-build.unit.5.md.in, create, podman-image.unit.5.md.in, pull, run
2+
####> podman create, pull, run
33
####> If file is edited, make sure the changes
44
####> are applicable to all of those.
5-
<< if is_quadlet >>
6-
### `Arch=ARCH`
7-
<< else >>
85
#### **--arch**=*ARCH*
9-
<< endif >>
10-
116
Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`.
127
Unless overridden, subsequent lookups of the same image in the local storage matches this architecture, regardless of the host.

docs/source/markdown/options/authfile.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
####> This option file is used in:
2-
####> podman artifact pull, artifact push, auto update, build, podman-build.unit.5.md.in, container runlabel, create, farm build, image sign, podman-image.unit.5.md.in, kube play, login, logout, manifest add, manifest inspect, manifest push, pull, push, run, search
2+
####> podman artifact pull, artifact push, auto update, build, container runlabel, create, farm build, image sign, kube play, login, logout, manifest add, manifest inspect, manifest push, pull, push, run, search
33
####> If file is edited, make sure the changes
44
####> are applicable to all of those.
5-
<< if is_quadlet >>
6-
### `AuthFile=path`
7-
<< else >>
85
#### **--authfile**=*path*
9-
<< endif >>
106

117
Path of the authentication file. Default is `${XDG_RUNTIME_DIR}/containers/auth.json` on Linux, and `$HOME/.config/containers/auth.json` on Windows/macOS.
128
The file is created by **[podman login](podman-login.1.md)**. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using **docker login**.

docs/source/markdown/options/auto-update.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/source/markdown/options/cap-add.image.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,7 @@
22
####> podman build, farm build
33
####> If file is edited, make sure the changes
44
####> are applicable to all of those.
5-
<< if is_quadlet >>
6-
### `AddCapability=CAP_xxx`
7-
<< else >>
85
#### **--cap-add**=*CAP\_xxx*
9-
<< endif >>
10-
116

127
When executing RUN instructions, run the command specified in the instruction
138
with the specified capability added to its capability set.

0 commit comments

Comments
 (0)