From 767003cd115da71832c8007cf328154b1a0c8dfd Mon Sep 17 00:00:00 2001 From: Matthias Ringwald Date: Tue, 25 May 2021 08:53:22 +0200 Subject: [PATCH] docu: add version to pdf --- doc/manual/Makefile | 3 ++- doc/manual/btstack_gettingstarted.tex | 4 ++-- doc/manual/update_getting_started.sh | 16 ++++++++++++++++ 3 files changed, 20 insertions(+), 3 deletions(-) create mode 100755 doc/manual/update_getting_started.sh diff --git a/doc/manual/Makefile b/doc/manual/Makefile index 9da66461c..630f23d76 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -12,9 +12,10 @@ pdf: rm -rf latex mkdir -p latex cp -r docs/picts latex + # create latex/btstack_gettingstartec.tex with version + ./update_getting_started.sh # create latex/btstack_generated.md -> latex/btstack_final.tex ./markdown2tex.py - cp btstack_gettingstarted.tex latex cp docs/ports/*.jpg latex cd latex && pdflatex btstack_gettingstarted.tex && pdflatex btstack_gettingstarted.tex mv latex/btstack_gettingstarted.pdf btstack.pdf diff --git a/doc/manual/btstack_gettingstarted.tex b/doc/manual/btstack_gettingstarted.tex index 7e9f34fc5..e103221f2 100644 --- a/doc/manual/btstack_gettingstarted.tex +++ b/doc/manual/btstack_gettingstarted.tex @@ -71,7 +71,7 @@ morekeywords={*, btstack_timer_source_t, btstack_data_source_t, uint32_t, uint16 le_characteristic_event_t} } -\newcommand{\versionNr}{1.0} +\newcommand{\versionNr}{VERSION} \newcommand{\authorMila}{Dr. sc. Milanka Ringwald} \newcommand{\authorMatthias}{Dr. sc. Matthias Ringwald} \newcommand{\bkContact}{\href{contact@bluekitchen-gmbh.com}{contact@bluekitchen-gmbh.com}} @@ -89,7 +89,7 @@ morekeywords={*, btstack_timer_source_t, btstack_data_source_t, uint32_t, uint16 \end{minipage} \hfill\begin{minipage}[b]{.8\textwidth}\begin{flushright} {\color{bkblue} - VERSION \versionNr{} \\ + Version \versionNr{} \\ \today \\} \vspace*{7.5cm} \hfill\includegraphics[width=0.85\textwidth]{picts/bklogo.pdf} diff --git a/doc/manual/update_getting_started.sh b/doc/manual/update_getting_started.sh new file mode 100755 index 000000000..74a79135c --- /dev/null +++ b/doc/manual/update_getting_started.sh @@ -0,0 +1,16 @@ +#!/usr/bin/env sh + +# get commit and tag +tag=`git tag --points-at HEAD` +commit=`git rev-parse --short HEAD` + +# use tag if available +if [ -z "$tag" ] +then + version=$commit +else + version=$tag +fi + +# create mkdocs.yml +sed -e "s|VERSION|$version|" btstack_gettingstarted.tex > latex/btstack_gettingstarted.tex