From 08418a486d5dbc0a5de9896a32c6ad44e6b5f4a6 Mon Sep 17 00:00:00 2001 From: Matt Liggett Date: Thu, 5 Nov 2015 14:16:26 -0800 Subject: [PATCH] Add debugging output to mungedocs when --verbose=true. Hope to understand why verify-generated-docs is failing on jenkins but not here. --- cmd/mungedocs/mungedocs.go | 5 +++++ hack/after-build/verify-generated-docs.sh | 5 +++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/cmd/mungedocs/mungedocs.go b/cmd/mungedocs/mungedocs.go index 7f98a5d9ddd..d1b19e59093 100644 --- a/cmd/mungedocs/mungedocs.go +++ b/cmd/mungedocs/mungedocs.go @@ -29,6 +29,7 @@ import ( ) 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.") 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 @@ -108,6 +109,10 @@ func (f fileProcessor) visit(path string) error { filePrinted = true } fmt.Printf("%s:\n", munge.name) + if *verbose { + fmt.Printf("INPUT: <<<%v>>>\n", mungeLines) + fmt.Printf("MUNGED: <<<%v>>>\n", after) + } if err != nil { fmt.Println(err) errFound = true diff --git a/hack/after-build/verify-generated-docs.sh b/hack/after-build/verify-generated-docs.sh index 7fb6364fb17..10cf34305fe 100755 --- a/hack/after-build/verify-generated-docs.sh +++ b/hack/after-build/verify-generated-docs.sh @@ -35,7 +35,8 @@ EXAMPLEROOT="${KUBE_ROOT}/examples/" # 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. -"${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 echo "${DOCROOT} is out of date. Please run hack/update-generated-docs.sh" exit 1 @@ -45,7 +46,7 @@ if [[ $ret -gt 1 ]]; then exit 1 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 echo "${EXAMPLEROOT} is out of date. Please run hack/update-generated-docs.sh" exit 1