Skip to content

Commit

Permalink
docs/: prefix manpages with "containers-"
Browse files Browse the repository at this point in the history
Prefix manpages with "containers-" and propagate the change into the
manpages.  Furthermore, make sure that the manpages have the NAME and
DESCRIPTION section to make them be indexed by `man -k` and `apropos`.

Fixes: #492
Signed-off-by: Valentin Rothberg <vrothberg@suse.com>
  • Loading branch information
vrothberg committed Aug 23, 2018
1 parent c07087f commit b16716c
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 10 deletions.
6 changes: 4 additions & 2 deletions docs/policy.json.md → docs/containers-policy.json.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
% POLICY.JSON(5) policy.json Man Page
% CONTAINERS-POLICY.JSON(5) policy.json Man Page
% Miloslav Trmač
% September 2016

# NAME
policy.json - syntax for the signature verification policy file
containers-policy.json - syntax for the signature verification policy file

## DESCRIPTION

Expand Down Expand Up @@ -278,4 +278,6 @@ selectively allow individual transports and scopes as desired.
atomic(1)

## HISTORY
August 2018, Rename to containers-policy.json(5) by Valentin Rothberg <vrothberg@suse.com>

September 2016, Originally compiled by Miloslav Trmač <mitr@redhat.com>
18 changes: 12 additions & 6 deletions docs/registries.conf.5.md → docs/containers-registries.conf.5.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
% registries.conf(5) System-wide registry configuration file
% CONTAINERS-REGISTRIES.CONF(5) System-wide registry configuration file
% Brent Baude
% Aug 2017

# NAME
registries.conf - Syntax of System Registry Configuration File
containers-registries.conf - Syntax of System Registry Configuration File

# DESCRIPTION
The REGISTRIES configuration file is a system-wide configuration file for container image
registries. The file format is TOML. The valid categories are: 'registries.search',
'registries.insecure', and 'registries.block'.
The CONTAINERS-REGISTRIES configuration file is a system-wide configuration
file for container image registries. The file format is TOML. The valid
categories are: 'registries.search', 'registries.insecure', and
'registries.block'.

By default, the configuration file is located at `/etc/containers/registries.conf`.

# FORMAT
The TOML_format is used to build a simple list format for registries under three
Expand Down Expand Up @@ -46,5 +49,8 @@ registries = ['registry.untrusted.com', 'registry.unsafe.com']
```

# HISTORY
Aug 2017, Originally compiled by Brent Baude <bbaude@redhat.com>
Aug 2018, Renamed to containers-registries.conf(5) by Valentin Rothberg <vrothberg@suse.com>

Jun 2018, Updated by Tom Sweeney <tsweeney@redhat.com>

Aug 2017, Originally compiled by Brent Baude <bbaude@redhat.com>
8 changes: 6 additions & 2 deletions docs/registries.d.md → docs/containers-registries.d.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
% REGISTRIES.D(5) Registries.d Man Page
% CONTAINERS-REGISTRIES.D(5) Registries.d Man Page
% Miloslav Trmač
% August 2016
# Registries Configuration Directory

# NAME
containers-registries.d - Directory for various registries configurations

# DESCRIPTION

The registries configuration directory contains configuration for various registries
(servers storing remote container images), and for content stored in them,
Expand Down

0 comments on commit b16716c

Please sign in to comment.