containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Emergency fix for man pages: check for broken includes 

Somehow the options/secret.md file generated corrupt md which
then generated corrupt .man files. Fix, and add a Makefile
check to prevent this from happening again.

Signed-off-by: Ed Santiago <santiago@redhat.com>
This commit is contained in:
Ed Santiago 2023-02-16 18:23:13 -07:00
parent 71f3e9834b
commit 9622d25be9
2 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Makefile
View File

@ -469,6 +469,11 @@ $(MANPAGES): %: %.md .install.md2man docdir
-e 's;<\(/\)\?\(a\|a\s\+[^>]*\|sup\)>;;g' \
-e 's/\\$$/ /g' $< |\
$(GOMD2MAN) -out $(subst source/markdown,build/man,$@)
# FIXME: 2023-02-16: we may need a multi-commit approach to
# enable this.
# @if grep 'included file options/' docs/build/man/*; then \
# echo "FATAL: man pages must not contain ^^^^"; exit 1; \
# fi
.PHONY: docdir
docdir:

18
docs/source/markdown/options/secret.md
View File

@ -36,11 +36,17 @@ Secret Options
Examples
Mount at `/my/location/mysecret` with UID 1.
```--secret mysecret,target=/my/location/mysecret,uid=1```
Mount at `/my/location/mysecret` with UID 1:
```
--secret mysecret,target=/my/location/mysecret,uid=1
```
Mount at `/run/secrets/customtarget` with mode 0777.
```--secret mysecret,target=customtarget,mode=0777```
Mount at `/run/secrets/customtarget` with mode 0777:
```
--secret mysecret,target=customtarget,mode=0777
```
Create a secret environment variable called `ENVSEC`.
```--secret mysecret,type=env,target=ENVSEC```
Create a secret environment variable called `ENVSEC`:
```
--secret mysecret,type=env,target=ENVSEC
```