github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-04 01:40:07 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #17987 from mml/mungedocs

Browse Source 
Auto commit by PR queue bot
This commit is contained in:
k8s-merge-robot 2015-12-04 02:13:54 -08:00
commit 6f6e97f2e4
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cmd/mungedocs/mungedocs.go
View File

@ -29,6 +29,7 @@ import (
) )
var ( var (
verbose = flag.Bool("verbose", false, "On verification failure, emit pre-munge and post-munge versions.")
verify = flag.Bool("verify", false, "Exit with status 1 if files would have needed changes but do not change.") verify = flag.Bool("verify", false, "Exit with status 1 if files would have needed changes but do not change.")
rootDir = flag.String("root-dir", "", "Root directory containing documents to be processed.") rootDir = flag.String("root-dir", "", "Root directory containing documents to be processed.")
// "repo-root" seems like a dumb name, this is the relative path (from rootDir) to get to the repoRoot // "repo-root" seems like a dumb name, this is the relative path (from rootDir) to get to the repoRoot
@ -108,6 +109,10 @@ func (f fileProcessor) visit(path string) error {
filePrinted = true filePrinted = true
} }
fmt.Printf("%s:\n", munge.name) fmt.Printf("%s:\n", munge.name)
if *verbose {
fmt.Printf("INPUT: <<<%v>>>\n", mungeLines)
fmt.Printf("MUNGED: <<<%v>>>\n", after)
}
if err != nil { if err != nil {
fmt.Println(err) fmt.Println(err)
errFound = true errFound = true

5
hack/after-build/verify-generated-docs.sh
View File

@ -35,7 +35,8 @@ EXAMPLEROOT="${KUBE_ROOT}/examples/"
# mungedocs --verify can (and should) be run on the real docs, otherwise their # mungedocs --verify can (and should) be run on the real docs, otherwise their
# links will be distorted. --verify means that it will not make changes. # links will be distorted. --verify means that it will not make changes.
"${mungedocs}" "--verify=true" "--root-dir=${DOCROOT}" && ret=0 || ret=$? # --verbose gives us output we can use for a diff.
"${mungedocs}" "--verify=true" "--verbose=true" "--root-dir=${DOCROOT}" && ret=0 || ret=$?
if [[ $ret -eq 1 ]]; then if [[ $ret -eq 1 ]]; then
echo "${DOCROOT} is out of date. Please run hack/update-generated-docs.sh" echo "${DOCROOT} is out of date. Please run hack/update-generated-docs.sh"
exit 1 exit 1
@ -45,7 +46,7 @@ if [[ $ret -gt 1 ]]; then
exit 1 exit 1
fi fi
"${mungedocs}" "--verify=true" "--root-dir=${EXAMPLEROOT}" && ret=0 || ret=$? "${mungedocs}" "--verify=true" "--verbose=true" "--root-dir=${EXAMPLEROOT}" && ret=0 || ret=$?
if [[ $ret -eq 1 ]]; then if [[ $ret -eq 1 ]]; then
echo "${EXAMPLEROOT} is out of date. Please run hack/update-generated-docs.sh" echo "${EXAMPLEROOT} is out of date. Please run hack/update-generated-docs.sh"
exit 1 exit 1