hack/lib/util/docs.sh - main - githubmirror/origin

hack/lib/util/docs.sh
105 строк3 KB
Alex Crawford
Use a more portable shell invocation
03 дек 2018, 22:24
03 дек 2018, 22:24e0d06d8
#!/usr/bin/env bash
#
# This library holds utility functions related to the generation
# of manpages and docs.


function generate_manual_pages() {
	local dest="$1"
	local cmdName="$2"
	local filestore=".files_generated_${cmdName}"
	local skipprefix="${3:-}"

	os::util::environment::setup_tmpdir_vars generate/manuals
	os::cleanup::tmpdir

	# We do this in a tmpdir in case the dest has other non-autogenned files
	# We don't want to include them in the list of gen'd files
	local tmpdir="${BASETMPDIR}/gen_man"
	mkdir -p "${tmpdir}"
	# generate the new files
	genman "${tmpdir}" "${cmdName}"
	# create the list of generated files
	ls "${tmpdir}" | LC_ALL=C sort > "${tmpdir}/${filestore}"

	# remove all old generated file from the destination
	while read file; do
		if [[ -e "${tmpdir}/${file}" && -n "${skipprefix}" ]]; then
			local original generated
			original=$(grep -v "^${skipprefix}" "${dest}/${file}") || :
			generated=$(grep -v "^${skipprefix}" "${tmpdir}/${file}") || :
			if [[ "${original}" == "${generated}" ]]; then
				# overwrite generated with original.
				mv "${dest}/${file}" "${tmpdir}/${file}"
			fi
		else
			rm "${dest}/${file}" || true
		fi
	done <"${dest}/${filestore}"

	# put the new generated file into the destination
	find "${tmpdir}" -exec rsync -pt {} "${dest}" \; >/dev/null
	#cleanup
	rm -rf "${tmpdir}"

	echo "Assets generated in ${dest}"
}
readonly -f generate_manual_pages

function generate_documentation() {
	local dest="$1"
	local skipprefix="${1:-}"

	os::util::environment::setup_tmpdir_vars generate/docs
	os::cleanup::tmpdir

	# We do this in a tmpdir in case the dest has other non-autogenned files
	# We don't want to include them in the list of gen'd files
	local tmpdir="${BASETMPDIR}/gen_doc"
	mkdir -p "${tmpdir}"
	# generate the new files
	gendocs "${tmpdir}"
	# create the list of generated files
	ls "${tmpdir}" | LC_ALL=C sort > "${tmpdir}/.files_generated"

	# remove all old generated file from the destination
	while read file; do
		if [[ -e "${tmpdir}/${file}" && -n "${skipprefix}" ]]; then
			local original generated
			original=$(grep -v "^${skipprefix}" "${dest}/${file}") || :
			generated=$(grep -v "^${skipprefix}" "${tmpdir}/${file}") || :
			if [[ "${original}" == "${generated}" ]]; then
				# overwrite generated with original.
				mv "${dest}/${file}" "${tmpdir}/${file}"
			fi
		else
			rm "${dest}/${file}" || true
		fi
	done <"${dest}/.files_generated"

	# put the new generated file into the destination
	find "${tmpdir}" -exec rsync -pt {} "${dest}" \; >/dev/null
	#cleanup
	rm -rf "${tmpdir}"

	echo "Assets generated in ${dest}"
}
readonly -f generate_documentation

# os::util::gen-docs generates docs and manpages for the all the binaries
# created for Origin.
function os::util::gen-docs() {
	os::util::ensure::built_binary_exists 'gendocs'
	os::util::ensure::built_binary_exists 'genman'

	OUTPUT_DIR_REL=${1:-""}
	OUTPUT_DIR="${OS_ROOT}/${OUTPUT_DIR_REL}/docs/generated"
	MAN_OUTPUT_DIR="${OS_ROOT}/${OUTPUT_DIR_REL}/docs/man/man1"

	mkdir -p "${OUTPUT_DIR}"
	mkdir -p "${MAN_OUTPUT_DIR}"

	generate_documentation "${OUTPUT_DIR}"
	generate_manual_pages "${MAN_OUTPUT_DIR}" "oc"
}
readonly -f os::util::gen-docs