diff options
| author | Albrecht Schlosser <albrechts.fltk@online.de> | 2024-08-12 19:58:32 +0200 |
|---|---|---|
| committer | Albrecht Schlosser <albrechts.fltk@online.de> | 2024-08-26 20:02:42 +0200 |
| commit | 9568d5bb737eb468e87fd43f21404e2def101e30 (patch) | |
| tree | 37dccaef760e15fa48d7d49569570ed6f2b3f88a /documentation/Makefile | |
| parent | 13f1911624359e8370c070981bb4b391b3caaae1 (diff) | |
Display Git revision in docs generated from releases (#499)
- makesrcdist: store Git revision in a file in the tarball
- CMake/resources.cmake: get git revision either from Git or file and
store it as CMake cache variable 'FLTK_GIT_REVISION' for reference
- documentation/*: get git revision from git or file
- fluid/documentation/*: get git revision from git or file
Diffstat (limited to 'documentation/Makefile')
| -rw-r--r-- | documentation/Makefile | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index a93345980..972c1b791 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -55,6 +55,17 @@ MANPAGES = $(SRC_DOCDIR)/fltk.$(CAT3EXT) $(SRC_DOCDIR)/fltk-config.$(CAT1EXT) \ $(SRC_DOCDIR)/checkers.$(CAT6EXT) $(SRC_DOCDIR)/sudoku.$(CAT6EXT) \ $(SRC_DOCDIR)/fltk-options.$(CAT1EXT) +# Get FLTK's Git Revision either from Git /or/ from fltk_git_rev.dat (Issue #499) +# +# Note: this may fail (return "unknown") if the sources were downloaded +# from GitHub as a "release" (zip) archive. This is not supported. + +# Test/debug only: should be commented out unless used (see: debug_git_rev) +# GIT_REV_FROM_GIT := "$$(git rev-parse HEAD 2>/dev/null)" +# GIT_REV_FROM_FILE := "$$(cat ../fltk_git_rev.dat 2>/dev/null)" + +FLTK_GIT_REVISION := "`( (git rev-parse HEAD || cat ../fltk_git_rev.dat;) || echo 'unknown'; ) 2>/dev/null`" + all: $(MANPAGES) # Use `make docs' to create all docs for distribution files. @@ -67,6 +78,11 @@ docs: all html pdf alldocs: docs dist: docs +debug_git_rev: + # echo "GIT_REV_FROM_GIT = $(GIT_REV_FROM_GIT)" + # echo "GIT_REV_FROM_FILE = $(GIT_REV_FROM_FILE)" + echo "FLTK_GIT_REVISION = $(FLTK_GIT_REVISION)" + clean: $(RM) Doxyfile Doxybook $(RM) copyright.dox generated.dox @@ -203,8 +219,7 @@ refman.pdf: $(HTMLFILES) Doxybook src/fltk-book.tex src/fltk-title.tex: src/fltk-title.tex.in echo "Generating $@ ..." - GIT_REVISION=`git rev-parse --short=10 HEAD`; \ - sed -e"s/@GIT_REVISION@/$$GIT_REVISION/g" \ + sed -e"s/@FLTK_GIT_REVISION@/$(FLTK_GIT_REVISION)/g" \ < $< > $@ src/fltk-book.tex.in: src/fltk-title.tex @@ -223,10 +238,9 @@ src/fltk-book.tex: src/fltk-book.tex.in generated.dox: generated.dox.in echo "Generating $@ ..." CURRENT_DATE=`date "+%b %d, %Y"`; \ - GIT_REVISION=`git rev-parse --short=10 HEAD`; \ DOXYGEN_VERSION_SHORT=`"$(DOXYDOC)" --version|cut -f1 -d' '`; \ sed -e"s/@CURRENT_DATE@/$$CURRENT_DATE/g" \ - -e"s/@GIT_REVISION@/$$GIT_REVISION/g" \ + -e"s/@FLTK_GIT_REVISION@/$(FLTK_GIT_REVISION)/g" \ -e"s/@DOXYGEN_VERSION_SHORT@/$$DOXYGEN_VERSION_SHORT/g" \ < $< > $@ |