Skip to content

Workaround go-md2man warning about HTML comments #2129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mtrmac wants to merge 1 commit into from
Closed

Workaround go-md2man warning about HTML comments #2129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/containers-policy.json.5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ This is expressed in JSON using the top-level syntax
The global `default` set of policy requirements is mandatory; all of the other fields
(`transports` itself, any specific transport, the transport-specific default, etc.) are optional.

<!-- NOTE: Keep this in sync with transports/transports.go! -->
[comment]: # (NOTE: Keep this in sync with transports/transports.go!)

## Supported transports and their scopes

See containers-transports(5) for general documentation about the transports and their reference syntax.
Expand Down Expand Up @@ -235,7 +236,8 @@ This requirement requires an image to be signed using “simple signing” with
"signedIdentity": identity_requirement
}
```
<!-- Later: other keyType values -->

[comment]: # (Later: other keyType values)

Exactly one of `keyPath`, `keyPaths` and `keyData` must be present, containing a GPG keyring of one or more public keys. Only signatures made by these keys are accepted.

Expand Down Expand Up @@ -309,7 +311,7 @@ If the `signedIdentity` field is missing, it is treated as `matchRepoDigestOrExa
provided by the transport. In particular, the `dir:` and `oci:` transports can be only
used with `exactReference` or `exactRepository`.

<!-- ### `signedBaseLayer` -->
[comment]: # (### `signedBaseLayer`)


### `sigstoreSigned`
Expand Down
2 changes: 1 addition & 1 deletion docs/containers-registries.d.5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ If no `docker` section can be found for the container image, and no `default-doc
A single configuration section is selected for a container image using the process
described above. The configuration section is a YAML mapping, with the following keys:

<!-- `sigstore` and `sigstore-staging` are deprecated and intentionally not documented here. -->
[comment]: # (`sigstore` and `sigstore-staging` are deprecated and intentionally not documented here.)

- `lookaside-staging` defines an URL of of the signature storage, used for editing it (adding or deleting signatures).

Expand Down
4 changes: 2 additions & 2 deletions docs/containers-transports.5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ they are evaluated. For example: if evaluated on a remote server, image names
might refer to paths on that server; relative paths are relative to the current
directory of the image consumer.

<!-- atomic: is deprecated and not documented here. -->
[comment]: # (atomic: is deprecated and not documented here.)

### **containers-storage**:[**[**storage-specifier**]**]{image-id|docker-reference[@image-id]}

Expand Down Expand Up @@ -91,7 +91,7 @@ An image using the Singularity image format at _path_.

Only reading images is supported, and not all scripts can be represented in the OCI format.

<!-- tarball: can only usefully be used from Go callers who call tarballReference.ConfigUpdate, and is not documented here. -->
[comment]: # (tarball: can only usefully be used from Go callers who call tarballReference.ConfigUpdate, and is not documented here.)

## Examples

Expand Down