Merge pull request #3882 from masatake/enhance--check-genfile

builds-sys/test: enhance  check-genfile target

Author: masatake

makefiles/testing.mak

@@ -309,70 +309,167 @@ clean-man-test:
 chkgen_verbose = $(chkgen_verbose_@AM_V@)
 chkgen_verbose_ = $(chkgen_verbose_@AM_DEFAULT_V@)
 chkgen_verbose_0 = @echo CHKGEN "    $@";
-check-genfile:
-if BUILD_IN_GIT_REPO
+
+cgok             =  echo "<ok>       $@:"
+cgerr            =  echo "<ERROR>    $@:"
+cgskip           =  echo "<skip>     $@:"
+
+recover_side_effects = cg-force-optlib2c-srcs cg-force-txt2cstr-srcs cg-force-man-docs
+
 # OPTLIB2C_SRCS : committed for win32 build
+.PHONY: cg-clean-optlib2c-srcs cg-force-optlib2c-srcs check-genfile-optlib2c-srcs
+cg-clean-optlib2c-srcs:
+if BUILD_IN_GIT_REPO
 	$(chkgen_verbose)rm -f $(OPTLIB2C_SRCS)
+endif
+cg-force-optlib2c-srcs: cg-clean-optlib2c-srcs
+if BUILD_IN_GIT_REPO
 	$(chkgen_verbose)$(MAKE) $(OPTLIB2C_SRCS)
+endif
+check-genfile-optlib2c-srcs: $(recover_side_effects) cg-force-optlib2c-srcs
+if BUILD_IN_GIT_REPO
 	$(chkgen_verbose)if ! git diff --exit-code $(OPTLIB2C_DIR); then \
-		echo "Files under $(OPTLIB2C_DIR) are not up to date." ; \
-		echo "If you change $(OPTLIB2C_DIR)/foo.ctags, don't forget to add $(OPTLIB2C_DIR)/foo.c to your commit." ; \
+		$(cgerr) "Files under $(OPTLIB2C_DIR) are not up to date." ; \
+		$(cgerr) "If you change $(OPTLIB2C_DIR)/foo.ctags, don't forget to add $(OPTLIB2C_DIR)/foo.c to your commit." ; \
 		exit 1 ; \
 	else \
-		echo "Files under $(OPTLIB2C_DIR) are up to date." ; \
+		$(cgok) "Files under $(OPTLIB2C_DIR) are up to date." ; \
 	fi
+endif
+
 # TXT2CSTR_SRCS : committed for win32 build
+.PHONY: cg-clean-txt2cstr-srcs cg-force-txt2cstr-srcs check-genfile-txt2cstr-srcs
+cg-clean-txt2cstr-srcs:
+if BUILD_IN_GIT_REPO
 	$(chkgen_verbose)rm -f $(TXT2CSTR_SRCS)
+endif
+cg-force-txt2cstr-srcs: cg-clean-txt2cstr-srcs
+if BUILD_IN_GIT_REPO
 	$(chkgen_verbose)$(MAKE) $(TXT2CSTR_SRCS)
+endif
+check-genfile-txt2cstr-srcs: $(recover_side_effects) cg-force-txt2cstr-srcs
+if BUILD_IN_GIT_REPO
 	$(chkgen_verbose)if ! git diff --exit-code $(TXT2CSTR_DIR); then \
-		echo "Files under $(TXT2CSTR_DIR) are not up to date." ; \
-		echo "If you change $(TXT2CSTR_DIR)/foo.ps, don't forget to add $(TXT2CSTR_DIR)/foo.c to your commit." ; \
+		$(cgerr) "Files under $(TXT2CSTR_DIR) are not up to date." ; \
+		$(cgerr) "If you change $(TXT2CSTR_DIR)/foo.ps, don't forget to add $(TXT2CSTR_DIR)/foo.c to your commit." ; \
 		exit 1 ; \
 	else \
-		echo "Files under $(TXT2CSTR_DIR) are up to date." ; \
+		$(cgok) "Files under $(TXT2CSTR_DIR) are up to date." ; \
 	fi
-if HAVE_RST2MAN
+endif
+
 # man/*.in : committed for man pages to be genrated without rst2man
 #   make clean-docs remove both man/*.in and docs/man/*.rst
+.PHONY: cg-clean-man-docs cg-force-man-docs check-genfile-man-docs
+cg-clean-man-docs:
+if BUILD_IN_GIT_REPO
+if HAVE_RST2MAN
 	$(chkgen_verbose)$(MAKE) -C man clean-docs
+endif
+endif
+cg-force-man-docs: cg-clean-man-docs
+if BUILD_IN_GIT_REPO
+if HAVE_RST2MAN
 	$(chkgen_verbose)$(MAKE) -C man man-in
+endif
+endif
+check-genfile-man-docs:  $(recover_side_effects) cg-force-man-docs
+if BUILD_IN_GIT_REPO
+if HAVE_RST2MAN
 	$(chkgen_verbose)if ! git diff --exit-code -- man; then \
-		echo "Files under man/ are not up to date." ; \
-		echo "Please execute 'make -C man man-in' and commit them." ; \
+		$(cgerr) "Files under man/ are not up to date." ; \
+		$(cgerr) "Please execute 'make -C man man-in' and commit them." ; \
 		exit 1 ; \
 	else \
-		echo "Files under man are up to date." ; \
+		$(cgok) "Files under man are up to date." ; \
 	fi
+endif
+endif
+
 # docs/man/*.rst : committed for Read the Docs
+.PHONY: cg-force-update-docs check-genfile-update-docs
+cg-force-update-docs: check-genfile-man-docs
+if BUILD_IN_GIT_REPO
+if HAVE_RST2MAN
 	$(chkgen_verbose)$(MAKE) -C man update-docs
+endif
+endif
+
+check-genfile-update-docs: cg-force-update-docs $(recover_side_effects)
+if BUILD_IN_GIT_REPO
+if HAVE_RST2MAN
 	$(chkgen_verbose)if ! git diff --exit-code -- docs/man; then \
-		echo "Files under docs/man/ are not up to date." ; \
-		echo "Please execute 'make -C man update-docs' and commit them." ; \
+		$(cgerr) "Files under docs/man/ are not up to date." ; \
+		$(cgerr) "Please execute 'make -C man update-docs' and commit them." ; \
 		exit 1 ; \
 	else \
-		echo "Files under docs/man are up to date." ; \
+		$(cgok) "Files under docs/man are up to date." ; \
 	fi
 endif
+endif
+
 # win32/ctags_vs2013.vcxproj* : committed for win32 build without POSIX tools
 #   regenerate files w/o out-of-source build and w/ GNU make
+.PHONY: cg-force-win32 check-genfile-win32
+cg-force-win32:
+if BUILD_IN_GIT_REPO
 	$(chkgen_verbose)if test "$(top_srcdir)" = "$(top_builddir)" \
 		&& ($(MAKE) --version) 2>/dev/null | grep -q GNU ; then \
 		$(MAKE) -BC win32 ; \
 	fi
+endif
+check-genfile-win32: cg-force-win32 $(recover_side_effects)
+if BUILD_IN_GIT_REPO
 	$(chkgen_verbose)if ! git diff --exit-code -- win32; then \
 		if test "$(SKIP_CHECKGEN_WIN32)" = "yes"; then \
-			echo "Skip checking the files under win32." ; \
+			$(cgskip) "Skip checking the files under win32." ; \
 			exit 0 ; \
 		else \
-			echo "Files under win32/ are not up to date." ; \
-			echo "Please execute 'make -BC win32' and commit them." ; \
+			$(cgerr) "Files under win32/ are not up to date." ; \
+			$(cgerr) "Please execute 'make -BC win32' and commit them." ; \
 			exit 1 ; \
 		fi \
 	else \
-		echo "Files under win32 are up to date." ; \
+		$(cgok) "Files under win32 are up to date." ; \
 	fi
 endif
 
+.PHONY: check-genfile-add-docs-man
+check-genfile-add-docs-man: $(recover_side_effects)
+	$(chkgen_verbose) {\
+		(cd man; git ls-files .) | grep ctags-lang- | sed -e 's/\.in$$//' > TEMP-MAN-LS; \
+		(cd docs/man; git ls-files .) | grep ctags-lang-  > TEMP-DOCS-MAN-LS; \
+		if ! diff TEMP-MAN-LS TEMP-DOCS-MAN-LS; then \
+			$(cgerr) 'See "<" lines above.'; \
+			$(cgerr) 'docs/man/*rst genereated from man/*rst.in are not in the git repo'; \
+			$(cgerr) 'Please add the genereated file to the git repo'; \
+			rm TEMP-MAN-LS TEMP-DOCS-MAN-LS; \
+			exit 1 ; \
+		else \
+			rm TEMP-MAN-LS TEMP-DOCS-MAN-LS; \
+			$(cgok) 'All rst files under docs/man are in our git repo'; \
+		fi; \
+	}
+
+.PHONY: check-genfile-docs-man-pages-rst
+check-genfile-docs-man-pages-rst: $(recover_side_effects)
+	$(chkgen_verbose) for f in $$( (cd docs/man; git ls-files .) | grep ctags-lang- ); do \
+		if ! grep -q $$f docs/man-pages.rst; then \
+			$(cgerr) "$$f is not found in docs/man-pages.rst"; \
+			$(cgerr) "Please add $$f to docs/man-pages.rst"; \
+			exit 1; \
+		fi; \
+	done; \
+	$(cgok) "docs/man-pages.rst includes all ctags-lang-*.rst"
+
+check-genfile: \
+	check-genfile-optlib2c-srcs \
+	check-genfile-txt2cstr-srcs \
+	check-genfile-update-docs \
+	check-genfile-add-docs-man \
+	check-genfile-docs-man-pages-rst \
+	check-genfile-win32
+
 #
 # Test installation
 #