comparison doc/interpreter/module.mk @ 31583:24b71381cbfa stable

doc: Use Makefile rules to auto-generate EDITION Texinfo variable for octave.texi * octave.texi: Use @include to include new "octave-doc-version.texi" file with EDITION variable. Use @value{EDITION} in @subtitle macro to avoid having to manually change text for every release. * doc/interpreter/module.mk: New rule to build "octave-doc-version.texi" which depends on "version-octave.texi" that is created by Automake. Change documentation target rules for .info, .dvi, .pdf, .html to depend on "octave-doc-version.texi". Add new file to doc_EXTRA_DIST and doc_MAINTAINERCLEANFILES to distribute it in tarball and to clean it up.
author Rik <rik@octave.org>
date Mon, 28 Nov 2022 19:54:09 -0800
parents 473ac0a602b9
children e863066429f1
comparison
equal deleted inserted replaced
31581:017ec2d748f7 31583:24b71381cbfa
269 $(QCOLLECTIONGENERATOR) $(QCOLLECTIONGENERATORFLAGS) %reldir%/octave_interpreter.qhcp -o %reldir%/octave_interpreter.qhc >/dev/null && \ 269 $(QCOLLECTIONGENERATOR) $(QCOLLECTIONGENERATORFLAGS) %reldir%/octave_interpreter.qhcp -o %reldir%/octave_interpreter.qhc >/dev/null && \
270 rm -f %reldir%/octave_interpreter.qhcp %reldir%/octave_interpreter.qhp 270 rm -f %reldir%/octave_interpreter.qhcp %reldir%/octave_interpreter.qhp
271 271
272 endif 272 endif
273 273
274 $(srcdir)/%reldir%/octave.info: %reldir%/octave.texi $(srcdir)/%reldir%/version-octave.texi 274 # Create a version file where EDITION variable only holds MAJOR number
275 $(srcdir)/%reldir%/octave-doc-version.texi: $(srcdir)/%reldir%/version-octave.texi
276 $(AM_V_GEN)rm -f $@-t $@ ; \
277 $(SED) 's#\(@set EDITION [0-9]\+\)\..*$$#\1#' $(srcdir)/%reldir%/version-octave.texi > $@-t ; \
278 mv $@-t $@
279
280 $(srcdir)/%reldir%/octave.info: %reldir%/octave.texi $(srcdir)/%reldir%/octave-doc-version.texi
275 $(AM_V_MAKEINFO)restore=: && backupdir="$(am__leading_dot)am$$$$" && \ 281 $(AM_V_MAKEINFO)restore=: && backupdir="$(am__leading_dot)am$$$$" && \
276 am__cwd=`pwd` && $(am__cd) $(srcdir) && \ 282 am__cwd=`pwd` && $(am__cd) $(srcdir) && \
277 rm -rf $$backupdir && mkdir $$backupdir && \ 283 rm -rf $$backupdir && mkdir $$backupdir && \
278 if ($(MAKEINFO) --version) >/dev/null 2>&1; then \ 284 if ($(MAKEINFO) --version) >/dev/null 2>&1; then \
279 for f in $@ $@-[0-9] $@-[0-9][0-9] $(@:.info=).i[0-9] $(@:.info=).i[0-9][0-9]; do \ 285 for f in $@ $@-[0-9] $@-[0-9][0-9] $(@:.info=).i[0-9] $(@:.info=).i[0-9][0-9]; do \
291 $(am__cd) $(srcdir) && \ 297 $(am__cd) $(srcdir) && \
292 $$restore $$backupdir/* `echo "./$@" | sed 's|[^/]*$$||'`; \ 298 $$restore $$backupdir/* `echo "./$@" | sed 's|[^/]*$$||'`; \
293 fi; \ 299 fi; \
294 rm -rf $$backupdir; exit $$rc 300 rm -rf $$backupdir; exit $$rc
295 301
296 %reldir%/octave.dvi: %reldir%/octave.texi $(srcdir)/%reldir%/version-octave.texi | %reldir%/$(am__dirstamp) 302 %reldir%/octave.dvi: %reldir%/octave.texi $(srcdir)/%reldir%/octave-doc-version.texi | %reldir%/$(am__dirstamp)
297 $(AM_V_TEXI2DVI)TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ 303 $(AM_V_TEXI2DVI)TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \
298 MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I doc/interpreter -I $(srcdir)/doc/interpreter' \ 304 MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I doc/interpreter -I $(srcdir)/doc/interpreter' \
299 $(TEXI2DVI) $(AM_V_texinfo) --build-dir=$(@:.dvi=.t2d) -o $@ $(AM_V_texidevnull) \ 305 $(TEXI2DVI) $(AM_V_texinfo) --build-dir=$(@:.dvi=.t2d) -o $@ $(AM_V_texidevnull) \
300 `test -f '%reldir%/octave.texi' || echo '$(abs_top_srcdir)/'`%reldir%/octave.texi 306 `test -f '%reldir%/octave.texi' || echo '$(abs_top_srcdir)/'`%reldir%/octave.texi
301 307
302 %reldir%/octave.pdf: %reldir%/octave.texi $(srcdir)/%reldir%/version-octave.texi | %reldir%/$(am__dirstamp) 308 %reldir%/octave.pdf: %reldir%/octave.texi $(srcdir)/%reldir%/octave-doc-version.texi | %reldir%/$(am__dirstamp)
303 $(AM_V_TEXI2PDF)TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \ 309 $(AM_V_TEXI2PDF)TEXINPUTS="$(am__TEXINFO_TEX_DIR)$(PATH_SEPARATOR)$$TEXINPUTS" \
304 MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I doc/interpreter -I $(abs_top_srcdir)/doc/interpreter' \ 310 MAKEINFO='$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I doc/interpreter -I $(abs_top_srcdir)/doc/interpreter' \
305 $(TEXI2PDF) $(AM_V_texinfo) --build-dir=$(@:.pdf=.t2p) -o $@ $(AM_V_texidevnull) \ 311 $(TEXI2PDF) $(AM_V_texinfo) --build-dir=$(@:.pdf=.t2p) -o $@ $(AM_V_texidevnull) \
306 `test -f '%reldir%/octave.texi' || echo '$(abs_top_srcdir)/'`%reldir%/octave.texi 312 `test -f '%reldir%/octave.texi' || echo '$(abs_top_srcdir)/'`%reldir%/octave.texi
307 313
308 %reldir%/octave.html: $(OCTAVE_HTML_STAMP) 314 %reldir%/octave.html: $(OCTAVE_HTML_STAMP)
309 315
310 $(OCTAVE_HTML_STAMP): %reldir%/octave.texi $(srcdir)/%reldir%/version-octave.texi | %reldir%/$(am__dirstamp) 316 $(OCTAVE_HTML_STAMP): %reldir%/octave.texi $(srcdir)/%reldir%/octave-doc-version.texi | %reldir%/$(am__dirstamp)
311 $(AM_V_MAKEINFO)rm -rf $(OCTAVE_HTML_DIR) 317 $(AM_V_MAKEINFO)rm -rf $(OCTAVE_HTML_DIR)
312 $(AM_V_at)if $(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) \ 318 $(AM_V_at)if $(MAKEINFOHTML) $(AM_MAKEINFOHTMLFLAGS) $(MAKEINFOFLAGS) \
313 -I doc/interpreter -I $(abs_top_srcdir)/doc/interpreter \ 319 -I doc/interpreter -I $(abs_top_srcdir)/doc/interpreter \
314 --css-ref=octave.css \ 320 --css-ref=octave.css \
315 -o $(OCTAVE_HTML_TMP_DIR) `test -f '%reldir%/octave.texi' || echo '$(abs_top_srcdir)/'`%reldir%/octave.texi; \ 321 -o $(OCTAVE_HTML_TMP_DIR) `test -f '%reldir%/octave.texi' || echo '$(abs_top_srcdir)/'`%reldir%/octave.texi; \
418 %reldir%/macros.texi \ 424 %reldir%/macros.texi \
419 %reldir%/mk-doc-cache.pl \ 425 %reldir%/mk-doc-cache.pl \
420 %reldir%/mk-qthelp.pl \ 426 %reldir%/mk-qthelp.pl \
421 %reldir%/mkcontrib.awk \ 427 %reldir%/mkcontrib.awk \
422 %reldir%/munge-texi.pl \ 428 %reldir%/munge-texi.pl \
429 %reldir%/octave-doc-version.texi \
423 $(DOC_IMAGES) \ 430 $(DOC_IMAGES) \
424 $(DOC_IMAGES_SRC) \ 431 $(DOC_IMAGES_SRC) \
425 $(LOGOS) \ 432 $(LOGOS) \
426 $(TXI_SRC) 433 $(TXI_SRC)
427 434
428 doc_MAINTAINERCLEANFILES += \ 435 doc_MAINTAINERCLEANFILES += \
429 AUTHORS \ 436 AUTHORS \
437 %reldir%/octave-doc-version.texi \
430 $(BUILT_DOC_IMAGES) \ 438 $(BUILT_DOC_IMAGES) \
431 $(BUILT_OCTAVE_TEXI_SRC) \ 439 $(BUILT_OCTAVE_TEXI_SRC) \
432 $(OCTAVE_QTHELP_FILES) 440 $(OCTAVE_QTHELP_FILES)
433 441
434 ## The TeX software suite is used to create both PDF and PS output formats. 442 ## The TeX software suite is used to create both PDF and PS output formats.