From: Colin Clark Date: Sat, 28 Oct 2017 11:07:11 +0000 (+0100) Subject: Auto-generate README and ChangeLog html user docs X-Git-Tag: v1.4~44 X-Git-Url: http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=commitdiff_plain;h=fe137c119524dd46c4cfd3e78e0e7d004ab4dd7d Auto-generate README and ChangeLog html user docs Change Makefile.am to: Run markdown to create README.html from README.md Run git to create new ChangeLog file and ChangeLog.html from that Revise format of ChangeLog.html If markdown or git executables are not present, do nothing --- diff --git a/Makefile.am b/Makefile.am index 1b97acef..5f21e2f1 100644 --- a/Makefile.am +++ b/Makefile.am @@ -31,3 +31,10 @@ dist-hook: geeqie.spec cp $(top_builddir)/geeqie.spec $(distdir) DISTCLEANFILES = config.report + +.PHONY: ChangeLog.html +ChangeLog.html: + ./gen_changelog.sh + +README.html: README.md + ./gen_readme.sh diff --git a/gen_changelog.sh b/gen_changelog.sh index ae42af97..2b37d19d 100755 --- a/gen_changelog.sh +++ b/gen_changelog.sh @@ -1,7 +1,7 @@ #!/bin/bash # Script to update ChangeLog file, -# it keeps "pre-svn" history and insert svn log at top, +# it keeps "pre-svn" history and inserts git log at top, # it uses C locale for date format. # It has to be run where ChangeLog is. # Old ChangeLog is saved as ChangeLog.bak @@ -9,6 +9,7 @@ # ChangeLog.html is also created [ ! -e "ChangeLog" ] && exit 1 +[ ! -x "$(command -v git)" ] && exit 1 tail -6614 ChangeLog > ChangeLog.$$.old && \ LC_ALL=C git log --no-merges --no-notes --encoding=UTF-8 --no-follow 1b58572cf58e9d2d4a0305108395dab5c66d3a09..HEAD > ChangeLog.$$.new && \ @@ -22,9 +23,9 @@ rm -f ChangeLog.$$.old echo "

" > ChangeLog.$$.new.html && \ +cat ChangeLog.$$.old.html >> ChangeLog.$$.new.html +[ -e ChangeLog.html ] && mv -f ChangeLog.html ChangeLog.html.bak mv -f ChangeLog.$$.new.html ChangeLog.html rm -f ChangeLog.$$.old.html diff --git a/gen_readme.sh b/gen_readme.sh new file mode 100755 index 00000000..a308453b --- /dev/null +++ b/gen_readme.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +# Script to create README.html file, + +[ ! -e "README.md" ] && exit 1 +[ ! -x "$(command -v markdown)" ] && exit 1 + +[ -e README.html ] && mv -f README.html README.html.bak + +markdown README.md > README.html + +exit 0