Skip to content

Commit bbe1d76

Browse files
authored
Merge pull request #241 from runcom/fix-man
cmd/oci-image-tool/man: clarify unpack and create-runtime-bundle description
2 parents d9b45db + 1ec6417 commit bbe1d76

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

cmd/oci-image-tool/man/oci-image-tool-create-runtime-bundle.1.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
% OCI Community
33
% JULY 2016
44
# NAME
5-
oci-image-tool-create-runtime-bundle \- Create an OCI image runtime bundle
5+
oci-image-tool-create-runtime-bundle \- Create an OCI runtime bundle
66

77
# SYNOPSIS
88
**oci-image-tool create-runtime-bundle** [src] [dest] [flags]
99

1010
# DESCRIPTION
11-
`oci-image-tool create-runtime-bundle` generates an [OCI bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md) from an [OCI image layout](https://github.com/opencontainers/image-spec/blob/master/image-layout.md).
11+
`oci-image-tool create-runtime-bundle` validates an application/vnd.oci.image.manifest.v1+json and unpacks its layered filesystem to `dest/rootfs`, although the target directory is configurable with `--rootfs`. See **oci-image-tool-unpack**(1) for more details on this process.
1212

13+
Also translates the referenced config from application/vnd.oci.image.config.v1+json to a
14+
runtime-spec-compatible `dest/config.json`.
1315

1416
# OPTIONS
1517
**--help**
@@ -34,7 +36,7 @@ $ cd busybox-bundle && sudo runc run busybox
3436
```
3537

3638
# SEE ALSO
37-
**oci-image-tool(1)**, **runc**(1), **skopeo**(1)
39+
**oci-image-tool**(1), **runc**(1), **skopeo**(1)
3840

3941
# HISTORY
4042
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

cmd/oci-image-tool/man/oci-image-tool-unpack.1.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ oci-image-tool-unpack \- Unpack an image or image source layout
88
**oci-image-tool unpack** [src] [dest] [flags]
99

1010
# DESCRIPTION
11-
`oci-image-tool unpack` unpacks a given OCI image into a directory suitable to be used with `runc`.
12-
11+
`oci-image-tool unpack` validates an application/vnd.oci.image.manifest.v1+json and unpacks its layered filesystem to `dest`.
1312

1413
# OPTIONS
1514
**--help**
@@ -44,7 +43,7 @@ busybox-bundle
4443
```
4544

4645
# SEE ALSO
47-
**oci-image-tool(1)**, **skopeo**(1)
46+
**oci-image-tool**(1), **skopeo**(1)
4847

4948
# HISTORY
5049
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

cmd/oci-image-tool/man/oci-image-tool-validate.1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ busybox-oci: OK
2929
```
3030

3131
# SEE ALSO
32-
**oci-image-tool(1)**, **skopeo**(1)
32+
**oci-image-tool**(1), **skopeo**(1)
3333

3434
# HISTORY
3535
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

cmd/oci-image-tool/man/oci-image-tool.1.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@ oci-image-tool \- OCI (Open Container Initiative) image tool
2020
# COMMANDS
2121
**create-runtime-bundle**
2222
Create an OCI image runtime bundle
23-
See **oci-image-tool-create-runtime-bundle(1)** for full documentation on the **create-runtime-bundle** command.
23+
See **oci-image-tool-create-runtime-bundle**(1) for full documentation on the **create-runtime-bundle** command.
2424

2525
**unpack**
2626
Unpack an image or image source layout
27-
See **oci-image-tool-unpack(1)** for full documentation on the **unpack** command.
27+
See **oci-image-tool-unpack**(1) for full documentation on the **unpack** command.
2828

2929
**validate**
3030
Validate one or more image files
31-
See **oci-image-tool-validate(1)** for full documentation on the **validate** command.
31+
See **oci-image-tool-validate**(1) for full documentation on the **validate** command.
3232

3333
# SEE ALSO
34-
**oci-image-tool-create-runtime-bundle**, **ocitools-unpack**(1), **ocitools-validate**(1)
34+
**oci-image-tool-create-runtime-bundle**(1), **ocitools-unpack**(1), **ocitools-validate**(1)
3535

3636
# HISTORY
3737
July 2016, Originally compiled by Antonio Murdaca (runcom at redhat dot com)

0 commit comments

Comments
 (0)