Mercurial > octave
changeset 26326:d0c070f5c67a stable
build: make macros.texi a constructed file from macros.txi (bug #54216).
* doc/interpreter/macros.txi: Renamed from macros.texi.
* doc/interpreter/module.mk: Add "macros.texi" to main MUNGED_TEXI_SRC
variable. Add three rules so that octave.texi, install.texi, and bugs.texi
depend on macros.texi being built before they can be built.
Remove macros.texi from doc_EXTRA_DIST because it will be distributed as
a normal .texi file now.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 30 Dec 2018 19:57:22 -0800 |
parents | 4877f77d5e1d |
children | a025fcd02c60 1463d55540e6 |
files | doc/interpreter/macros.texi doc/interpreter/macros.txi doc/interpreter/module.mk |
diffstat | 3 files changed, 119 insertions(+), 114 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/macros.texi Sun Dec 30 13:26:33 2018 -0800 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,112 +0,0 @@ -@c Copyright (C) 2012-2018 John W. Eaton -@c -@c This file is part of Octave. -@c -@c Octave is free software: you can redistribute it and/or modify it -@c under the terms of the GNU General Public License as published by -@c the Free Software Foundation, either version 3 of the License, or -@c (at your option) any later version. -@c -@c Octave is distributed in the hope that it will be useful, but -@c WITHOUT ANY WARRANTY; without even the implied warranty of -@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -@c GNU General Public License for more details. -@c -@c You should have received a copy of the GNU General Public License -@c along with Octave; see the file COPYING. If not, see -@c <https://www.gnu.org/licenses/>. - -@c The following macro marks words that aspell should ignore during -@c spellchecking. Within Texinfo it has no effect as it merely replaces -@c the macro call with the argument itself. - -@macro nospell {arg} -\arg\ -@end macro - -@c The following macro works around the Info/plain text expansion of @code{XXX} -@c which is `XXX'. This looks particularly bad when the macro body is -@c single or double-quoted text, such as a property value `"position"' -@ifinfo -@macro qcode{arg} -\arg\ -@end macro -@end ifinfo -@ifnotinfo -@macro qcode{arg} -@code{\arg\} -@end macro -@end ifnotinfo - -@c The following macro is used for the on-line help system, but we don't -@c want lots of `See also: foo, bar, and baz' strings cluttering the -@c printed manual (that information should be in the supporting text for -@c each group of functions and variables). -@c -@c Implementation Note: -@c For TeX, @vskip produces a nice separation. -@c For Texinfo, '@sp 1' should work, but in practice produces ugly results -@c for HTML. We use a simple blank line to produce the correct behavior. - -@macro seealso {args} -@iftex -@vskip 2pt -@end iftex -@ifnottex - -@end ifnottex -@ifnotinfo -@noindent -@strong{See also:} \args\. -@end ifnotinfo -@ifinfo -@noindent -See also: \args\. -@end ifinfo -@end macro - -@c The following macro works around a situation where the Info/plain text -@c expansion of the @code{XXX} macro is `XXX'. The use of the apostrophe -@c can be confusing if the code segment itself ends with a transpose operator. -@ifinfo -@macro tcode{arg} -\arg\ -@end macro -@end ifinfo -@ifnotinfo -@macro tcode{arg} -@code{\arg\} -@end macro -@end ifnotinfo - -@c FIXME: someday, when Texinfo 5.X is standard, we might replace this with -@c @backslashchar, which is a new addition to Texinfo. - -@macro xbackslashchar -\\ -@end macro - -@c These may be useful for all, not just for octave.texi. -@tex - \ifx\rgbDarkRed\thisisundefined - \def\rgbDarkRed{0.50 0.09 0.12} - \fi - \ifx\linkcolor\thisisundefined - \relax - \else - \global\def\linkcolor{\rgbDarkRed} - \fi - \ifx\urlcolor\thisisundefined - \relax - \else - \global\def\urlcolor{\rgbDarkRed} - \fi - \ifx\urefurlonlylinktrue\thisisundefined - \relax - \else - \global\urefurlonlylinktrue - \fi -@end tex - -@c Make the apostrophe in code examples cut-and-paste friendly. -@codequoteundirected on
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/interpreter/macros.txi Sun Dec 30 19:57:22 2018 -0800 @@ -0,0 +1,112 @@ +@c Copyright (C) 2012-2018 John W. Eaton +@c +@c This file is part of Octave. +@c +@c Octave is free software: you can redistribute it and/or modify it +@c under the terms of the GNU General Public License as published by +@c the Free Software Foundation, either version 3 of the License, or +@c (at your option) any later version. +@c +@c Octave is distributed in the hope that it will be useful, but +@c WITHOUT ANY WARRANTY; without even the implied warranty of +@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +@c GNU General Public License for more details. +@c +@c You should have received a copy of the GNU General Public License +@c along with Octave; see the file COPYING. If not, see +@c <https://www.gnu.org/licenses/>. + +@c The following macro marks words that aspell should ignore during +@c spellchecking. Within Texinfo it has no effect as it merely replaces +@c the macro call with the argument itself. + +@macro nospell {arg} +\arg\ +@end macro + +@c The following macro works around the Info/plain text expansion of @code{XXX} +@c which is `XXX'. This looks particularly bad when the macro body is +@c single or double-quoted text, such as a property value `"position"' +@ifinfo +@macro qcode{arg} +\arg\ +@end macro +@end ifinfo +@ifnotinfo +@macro qcode{arg} +@code{\arg\} +@end macro +@end ifnotinfo + +@c The following macro is used for the on-line help system, but we don't +@c want lots of `See also: foo, bar, and baz' strings cluttering the +@c printed manual (that information should be in the supporting text for +@c each group of functions and variables). +@c +@c Implementation Note: +@c For TeX, @vskip produces a nice separation. +@c For Texinfo, '@sp 1' should work, but in practice produces ugly results +@c for HTML. We use a simple blank line to produce the correct behavior. + +@macro seealso {args} +@iftex +@vskip 2pt +@end iftex +@ifnottex + +@end ifnottex +@ifnotinfo +@noindent +@strong{See also:} \args\. +@end ifnotinfo +@ifinfo +@noindent +See also: \args\. +@end ifinfo +@end macro + +@c The following macro works around a situation where the Info/plain text +@c expansion of the @code{XXX} macro is `XXX'. The use of the apostrophe +@c can be confusing if the code segment itself ends with a transpose operator. +@ifinfo +@macro tcode{arg} +\arg\ +@end macro +@end ifinfo +@ifnotinfo +@macro tcode{arg} +@code{\arg\} +@end macro +@end ifnotinfo + +@c FIXME: someday, when Texinfo 5.X is standard, we might replace this with +@c @backslashchar, which is a new addition to Texinfo. + +@macro xbackslashchar +\\ +@end macro + +@c These may be useful for all, not just for octave.texi. +@tex + \ifx\rgbDarkRed\thisisundefined + \def\rgbDarkRed{0.50 0.09 0.12} + \fi + \ifx\linkcolor\thisisundefined + \relax + \else + \global\def\linkcolor{\rgbDarkRed} + \fi + \ifx\urlcolor\thisisundefined + \relax + \else + \global\def\urlcolor{\rgbDarkRed} + \fi + \ifx\urefurlonlylinktrue\thisisundefined + \relax + \else + \global\urefurlonlylinktrue + \fi +@end tex + +@c Make the apostrophe in code examples cut-and-paste friendly. +@codequoteundirected on
--- a/doc/interpreter/module.mk Sun Dec 30 13:26:33 2018 -0800 +++ b/doc/interpreter/module.mk Sun Dec 30 19:57:22 2018 -0800 @@ -142,6 +142,7 @@ %reldir%/intro.texi \ %reldir%/io.texi \ %reldir%/linalg.texi \ + %reldir%/macros.texi \ %reldir%/matrix.texi \ %reldir%/nonlin.texi \ %reldir%/numbers.texi \ @@ -360,6 +361,11 @@ $(MUNGED_TEXI_SRC): $(DOCSTRING_FILES) +## Additional dependency through @include +%reldir%/octave.texi: %reldir%/macros.texi +%reldir%/install.texi: %reldir%/macros.texi +%reldir%/bugs.texi: %reldir%/macros.texi + ## These two texi files have an additional dependency through the ## @EXAMPLEFILE macro. %reldir%/oop.texi: $(examples_code_SRC) @@ -406,7 +412,6 @@ %reldir%/images \ %reldir%/images.awk \ %reldir%/images.mk \ - %reldir%/macros.texi \ %reldir%/mk-doc-cache.pl \ %reldir%/mk-qthelp.pl \ %reldir%/mkcontrib.awk \ @@ -452,7 +457,7 @@ %reldir%/doc-cache: $(DOCSTRING_FILES) %reldir%/mk-doc-cache.pl | $(OCTAVE_INTERPRETER_TARGETS) %reldir%/$(octave_dirstamp) $(AM_V_GEN)rm -f $@-t $@ && \ - $(PERL) $(srcdir)/%reldir%/mk-doc-cache.pl $(srcdir) $(srcdir)/%reldir%/macros.texi $(DOCSTRING_FILES) > $@-t && \ + $(PERL) $(srcdir)/%reldir%/mk-doc-cache.pl $(srcdir) %reldir%/macros.texi $(DOCSTRING_FILES) > $@-t && \ mv $@-t $@ %reldir%/undocumented_list: