Merge pull request #17544 from edsantiago/emergency_man_fix

Emergency fix for man pages: check for broken includes
containers · Feb 17, 2023 · 445f72d · 445f72d
2 parents b55df7f + 9622d25
commit 445f72d
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 8 deletions.
diff --git a/Makefile b/Makefile
@@ -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:

diff --git a/docs/source/markdown/options/secret.md b/docs/source/markdown/options/secret.md
@@ -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 `/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```
+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
+```
+
+Create a secret environment variable called `ENVSEC`:
+```
+--secret mysecret,type=env,target=ENVSEC
+```