From 5cf77306257517a3d1ec8cea85fca34f576a8f22 Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Mon, 11 Dec 2017 22:36:00 -0800 Subject: doc: Don't 'publish' release notes, don't build pdf release notes All we use the release notes for is to include into the main AltOS page. Also remove the docinfo for these files so that information isn't duplicated for each set of release notes. Signed-off-by: Keith Packard --- doc/Makefile | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) (limited to 'doc/Makefile') diff --git a/doc/Makefile b/doc/Makefile index feb1de8f..aa266e75 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -186,7 +186,6 @@ SVG=\ telemini-v3.svg \ easymega.svg -RELNOTES_PDF=$(RELNOTES_INC:.inc=.pdf) RELNOTES_HTML=$(RELNOTES_INC:.inc=.html) ONEFILE_TXT_FILES=\ @@ -196,10 +195,13 @@ ONEFILE_TXT_FILES=\ ONEFILE_RAW_FILES=$(ONEFILE_TXT_FILES:.txt=.raw) ONEFILE_PDF_FILES=$(ONEFILE_TXT_FILES:.txt=.pdf) +ONEFILE_HTML_FILES=$(ONEFILE_TXT_FILES:.txt=.html) AM_HTML=am.html -HTML=altusmetrum.html micropeak.html telegps.html easymini.html $(RELNOTES_HTML) $(ONEFILE_HTML_FILES) +PUBLISH_HTML=altusmetrum.html micropeak.html telegps.html easymini.html $(ONEFILE_HTML_FILES) + +HTML=$(PUBLISH_HTML) $(RELNOTES_HTML) HTML_REVHISTORY=\ altusmetrum-revhistory.html \ @@ -207,7 +209,7 @@ HTML_REVHISTORY=\ telegps-revhistory.html \ easymini-revhistory.html -PDF=altusmetrum.pdf micropeak.pdf telegps.pdf easymini.pdf $(RELNOTES_PDF) $(ONEFILE_PDF_FILES) \ +PDF=altusmetrum.pdf micropeak.pdf telegps.pdf easymini.pdf $(ONEFILE_PDF_FILES) \ $(OUTLINE_PDF_FILES) FOP_STYLE=am-fo.xsl @@ -235,6 +237,8 @@ TEMPLATES_XSL=$(TEMPLATES_TMPL:.tmpl=.xsl) PDF_CONFIG_FILES=$(FOP_STYLE) $(COMMON_STYLE) $(FOP_XCONF) $(TEMPLATES_XSL) HTML_CONFIG_FILES=$(HTML_STYLE) $(COMMON_STYLE) $(TEMPLATES_XSL) +PUBLISH_DOC=$(PUBLISH_HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) + DOC=$(HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) .SUFFIXES: .tmpl .xsl .inc .txt .raw .pdf .html @@ -245,12 +249,12 @@ DOC=$(HTML) $(HTML_REVHISTORY) $(PDF) $(IMAGES) $(STYLESHEET) .inc.raw: sed -e 's/^[ ]*//' -e 's/^\\//' $*.inc > $@ -.raw.pdf: +.raw.html: a2x --verbose -a docinfo -f pdf --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(FOP_STYLE) --fop --fop-opts="-c $(FOP_XCONF)" $*.raw a2x --verbose -a docinfo -f xhtml --xsltproc-opts "--stringparam toc.section.depth 2" --xsl-file $(HTML_STYLE) --stylesheet=$(STYLESHEET) $*.raw case $* in release-notes*) ./fix-html $*.html ;; esac -.pdf.html: +.html.pdf: @touch $@ .tmpl.xsl: @@ -278,19 +282,21 @@ telemini-v3-outline.pdf: telemini-v3-outline.txt telemini-v3.svg install: all -publish: $(DOC) $(FONTS) - cp $(DOC) /home/bdale/web/altusmetrum/AltOS/doc/ - mkdir -p /home/bdale/web/altusmetrum/AltOS/doc/fonts/ - cp $(FONTS) /home/bdale/web/altusmetrum/AltOS/doc/fonts/ - (cd /home/bdale/web/altusmetrum ; \ - git add /home/bdale/web/altusmetrum/AltOS/doc/* ; \ - git add /home/bdale/web/altusmetrum/AltOS/doc/fonts/* ; \ +WEB_ROOT=/home/bdale/web/ + +publish: $(PUBLISH_DOC) $(FONTS) + cp $(PUBLISH_DOC) $(WEB_ROOT)/altusmetrum/AltOS/doc/ + mkdir -p $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/ + cp $(FONTS) $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/ + (cd $(WEB_ROOT)/altusmetrum ; \ + git add $(WEB_ROOT)/altusmetrum/AltOS/doc/* ; \ + git add $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* ; \ echo "update docs" | \ - git commit -F - /home/bdale/web/altusmetrum/AltOS/doc/* /home/bdale/web/altusmetrum/AltOS/doc/fonts/* ; \ + git commit -F - $(WEB_ROOT)/altusmetrum/AltOS/doc/* $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* ; \ git push) -publish-keithp: am.html $(DOC) $(FONTS) - scp -p am.html $(DOC) keithp.com:~keithp/public_html/altos +publish-keithp: am.html $(PUBLISH_DOC) $(FONTS) + scp -p am.html $(PUBLISH_DOC) keithp.com:~keithp/public_html/altos scp -p $(FONTS) keithp.com:~keithp/public_html/altos/fonts clean: -- cgit v1.2.3 From 4bcdc106df2c5e8572570e57b4d97121df94799a Mon Sep 17 00:00:00 2001 From: Keith Packard Date: Thu, 21 Dec 2017 17:36:24 -0800 Subject: Doc updates for version 1.8.4 Signed-off-by: Keith Packard --- doc/Makefile | 1 + doc/RELNOTES | 6 ++---- doc/altusmetrum-docinfo.xml | 7 +++++++ doc/easymini-docinfo.xml | 7 +++++++ doc/easymini-release-notes.inc | 4 ++++ doc/release-notes-1.8.4.inc | 9 +++++++++ doc/release-notes.inc | 5 +++++ doc/telegps-release-notes.inc | 5 +++++ 8 files changed, 40 insertions(+), 4 deletions(-) create mode 100644 doc/release-notes-1.8.4.inc (limited to 'doc/Makefile') diff --git a/doc/Makefile b/doc/Makefile index aa266e75..7d33149d 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -3,6 +3,7 @@ # RELNOTES_INC=\ + release-notes-1.8.4.inc \ release-notes-1.8.3.inc \ release-notes-1.8.2.inc \ release-notes-1.8.1.inc \ diff --git a/doc/RELNOTES b/doc/RELNOTES index 8f7d2540..c3980882 100644 --- a/doc/RELNOTES +++ b/doc/RELNOTES @@ -1,7 +1,6 @@ Creating documentation for a new release of AltOS -* Write release notes in release-notes-${version}.inc. Write docinfo - for release notes in release-notes-${version}-docinfo.xml. Add to +* Write release notes in release-notes-${version}.inc. Add to Makefile * Add references to that as appropriate from each of the @@ -30,5 +29,4 @@ Creating documentation for a new release of AltOS telegps-docinfo.xml telemetry-docinfo.xml -* Add release-notes-${version}.inc and - release-notes-${version}-docinfo.xml to git +* Add release-notes-${version}.inc to git diff --git a/doc/altusmetrum-docinfo.xml b/doc/altusmetrum-docinfo.xml index 3b0793b8..235111fc 100644 --- a/doc/altusmetrum-docinfo.xml +++ b/doc/altusmetrum-docinfo.xml @@ -46,6 +46,13 @@ + + 1.8.4 + 20 Dec 2017 + + Support EasyMini v2.0 hardware. + + 1.8.3 11 Dec 2017 diff --git a/doc/easymini-docinfo.xml b/doc/easymini-docinfo.xml index cf3f27d2..85baba1e 100644 --- a/doc/easymini-docinfo.xml +++ b/doc/easymini-docinfo.xml @@ -38,6 +38,13 @@ + + 1.8.4 + 20 Dec 2017 + + Support EasyMini v2.0 hardware. + + 1.6.3 21 April 2016 diff --git a/doc/easymini-release-notes.inc b/doc/easymini-release-notes.inc index f4f45fd7..dae928a6 100644 --- a/doc/easymini-release-notes.inc +++ b/doc/easymini-release-notes.inc @@ -1,5 +1,9 @@ [appendix] == Release Notes + :leveloffset: 2 + include::release-notes-1.8.4.raw[] + + <<<< :leveloffset: 2 include::release-notes-1.8.3.raw[] diff --git a/doc/release-notes-1.8.4.inc b/doc/release-notes-1.8.4.inc new file mode 100644 index 00000000..f8cb4f11 --- /dev/null +++ b/doc/release-notes-1.8.4.inc @@ -0,0 +1,9 @@ += Release Notes for Version 1.8.4 +:toc!: +:doctype: article + + Version 1.8.4 includes support for EasyMini version 2.0 + + == AltOS + + * Support for EasyMini version 2.0 hardware. diff --git a/doc/release-notes.inc b/doc/release-notes.inc index 1c177afa..50b27ab5 100644 --- a/doc/release-notes.inc +++ b/doc/release-notes.inc @@ -1,6 +1,11 @@ [appendix] == Release Notes + :leveloffset: 2 + include::release-notes-1.8.4.raw[] + + <<<< + :leveloffset: 2 include::release-notes-1.8.3.raw[] diff --git a/doc/telegps-release-notes.inc b/doc/telegps-release-notes.inc index 0c506c28..5c5da8f6 100644 --- a/doc/telegps-release-notes.inc +++ b/doc/telegps-release-notes.inc @@ -1,6 +1,11 @@ [appendix] == Release Notes + :leveloffset: 2 + include::release-notes-1.8.4.raw[] + + <<<< + :leveloffset: 2 include::release-notes-1.8.3.raw[] -- cgit v1.2.3