github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-06 03:33:26 +00:00
Code Issues Projects Releases Wiki Activity

Doc generation should remove old doc files

Browse Source 
Right now, our doc generation scripts notice if you make changes and
don't regen docs, don't include new docs, etc.  But they miss it if your
changes should have REMOVED a doc.  Both kubectl-apiversion and
kubectl-clusterinfo should have been removed, but weren't.

This patch starts tracking all generated doc files and will cause
problems if files should be removed and aren't.
This commit is contained in:
Eric Paris
2015-04-13 12:14:08 -04:00
parent 7464575b17
commit 26149bd83d
6 changed files with 102 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
hack/verify-gendocs.sh
View File

@@ -46,10 +46,13 @@ fi
DOCROOT="${KUBE_ROOT}/docs/"
TMP_DOCROOT="${KUBE_ROOT}/docs_tmp/"
cp -a "${DOCROOT}" "${TMP_DOCROOT}"
echo "diffing ${DOCROOT} against generated output from ${genman}"
${genman} "${TMP_DOCROOT}/man/man1/"
${gendocs} "${TMP_DOCROOT}"
kube::util::gen-doc "${genman}" "${TMP_DOCROOT}/man/man1/"
kube::util::gen-doc "${gendocs}" "${TMP_DOCROOT}"
echo "diffing ${DOCROOT} against freshly generated docs"
set +e
diff -Naupr -I 'Auto generated by' "${DOCROOT}" "${TMP_DOCROOT}"
ret=$?
@@ -57,16 +60,16 @@ set -e
rm -rf "${TMP_DOCROOT}"
if [ $ret -eq 0 ]
then
echo "${DOCROOT} up to date."
echo "${DOCROOT} up to date."
else
echo "${DOCROOT} is out of date. Please run hack/run-gendocs.sh"
exit 1
echo "${DOCROOT} is out of date. Please run hack/run-gendocs.sh"
exit 1
fi
COMPROOT="${KUBE_ROOT}/contrib/completions"
TMP_COMPROOT="${KUBE_ROOT}/contrib/completions_tmp"
cp -a "${COMPROOT}" "${TMP_COMPROOT}"
${genbashcomp} "${TMP_COMPROOT}/bash/"
kube::util::gen-doc "${genbashcomp}" "${TMP_COMPROOT}/bash/"
set +e
diff -Naupr "${COMPROOT}" "${TMP_COMPROOT}"
ret=$?
@@ -79,3 +82,5 @@ else
echo "${COMPROOT} is out of date. Please run hack/run-gendocs.sh"
exit 1
fi
# ex: ts=2 sw=2 et filetype=sh