magic/doc/latexfiles/Makefile.in

85 lines
3.5 KiB
Makefile
Raw Permalink Normal View History

# Provided by configure: the module's source dir + the build top.
# defs.mak sees `srcdir` already set and skips its own srcdir derivation.
srcdir = @srcdir@
VPATH = @srcdir@
MAGICDIR = @top_builddir@
include $(MAGICDIR)/defs.mak
build: out-of-tree .so variants, oa, and latexfiles PS regen Extend the out-of-tree build to the outliers deferred earlier, and audit install sourcing. All are read-source / write-build now. Tcl auto-load shared libraries (built via each module's `tcl-main`; not part of the default TCL build, but now correct when invoked): * lef/plot/router/ext2spice/ext2sim: the hand-written object rules (tcllef.o, tclplot.o, tclroute.o, spicewrap.o, spicehier.o, simwrap.o, ext2sim_main.o) compiled a bare-name source from the cwd; switch to `-c $< -o $@` so the source is found via VPATH and the object lands in the build tree. ext2sim_main.o also swaps the hard-coded -I${MAGICDIR} for ${CPPFLAGS} (build + source include paths). ext2spice spice2sim install copies $< (source script). Sibling ${MAGICDIR}/<mod>/lib*.o refs already resolve into the build tree (MAGICDIR = build top). oa (disabled by default; OpenAccess): * CXX_INCLUDES -I. -> -I$(srcdir) -I${MAGICDIR} -I${MAGICSRC} so the C++ sources, generated database/database.h, and cross-module headers all resolve out-of-tree; .deps and objects were already build-local. doc/latexfiles PostScript regeneration: * Split PS_SRCDIR (pre-built PS shipped in the source tree, read-only) from PS_GENDIR (= psfiles in the build tree). `all` / the .tex.ps rule now regenerate into PS_GENDIR (mkdir -p; latex reads $(srcdir) via TEXINPUTS; dvips writes the build tree) instead of writing back into the source psfiles dir. install takes each .ps from PS_GENDIR if regenerated there, else the pre-built PS_SRCDIR copy. Verified out-of-tree (make modules; then per-module tcl-main): * magiclef.so / tclplot.so / tclroute.so / exttospice.so / exttosim.so all build into the build tree (rc=0); oa.o builds into the build tree; source tree stays clean. * install-tcl copies each .so from the build tree. * Install-location audit on a full `make install DESTDIR=...`: generated data (scmos.tech, .magicrc, magic.tcl, tclmagic.so) matches the build tree; verbatim data (glyphs, fonts, magicps.pro, man pages, doc PS) matches the source tree. * DESTDIR: two distinct prefixes install 376 files each, independent and fully contained (nothing written outside DESTDIR). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 15:39:35 +02:00
# PS_SRCDIR: pre-built PostScript shipped in the source tree (read-only, used by
# install when a doc has not been regenerated).
# PS_GENDIR: regenerated PostScript, written into the build tree (never source).
build: out-of-tree outlier Makefiles — full make + install Fix the remaining non-standard Makefiles so a full out-of-tree `../configure && make && make install` builds and installs a complete magic TCL tree, sources read from the source tree, all outputs in the build tree. Shared linker/preprocessor paths (scripts/configure.in, regenerated scripts/configure): * --version-script=${MAGICDIR}/magic/symbol.map -> ${MAGICSRC}/... so every shared-library link (tclmagic.so, ...) finds the source map. * MCPP preproc.py path ${MAGICDIR}/scripts -> ${MAGICSRC}/scripts. Programs (built via tcllibrary, PROGRAMS = magic tcltk): * magic/Makefile: proto.magicrc, magicWasm.o and the bitmaps/.initrc/ magicps.pro install copies use $< / $(srcdir) instead of bare names. * tcltk/Makefile: magicexec/magicdnull compile $<; the sed'd launcher scripts (magic.tcl/.sh, ext2spice.sh, ext2sim.sh) read $<; VERSION dep -> ${MAGICSRC}; install-tcl copies each TCL file from the build dir if present else $(srcdir) (magic.tcl is generated, the rest are source). Techs (scmos): * scmos/Makefile: SC_PP template include -> $(srcdir)/extract_template; tech-file inputs (scmos.tech.in, *.tech.in) via $(srcdir)/$< ; recurse into cif_template with mkdir + -f ${MAGICSRC}/scmos/cif_template/Makefile; install copies from build-or-$(srcdir). * scmos/cif_template/Makefile: MKDIR -> ${MAGICSRC}/scripts/mkdirs; SC_CPP gains -I$(srcdir); cpp reads $(srcdir)/cif{in,out}.c so the .gen includes resolve; objs/ generated in the build tree. Data-file installs (source files copied from $(srcdir)): * graphics/Makefile: glyphs, outline fonts, and the X11 helper build. * windows/Makefile: glyphs and vector fonts. * doc/Makefile: recurse into man/tutcells/html/latexfiles build-aware; doc/man, doc/tutcells install with $< ; doc/html tars $(srcdir); doc/latexfiles reads pre-built PostScript from ${MAGICSRC}/doc/psfiles. Verified out-of-tree (mkdir _build; cd _build; ../configure): `make` returns rc=0 (33 module libs, tclmagic.so, magicexec/magicdnull, scmos tech files + cif_template objs, proto.magicrc), and `make install DESTDIR=...` returns rc=0 installing 376 files (bin/magic, tcl/tclmagic.so, sys/ glyphs+fonts+techs+dstyles), with the source tree left completely clean. Not exercised by the default TCL build/install and therefore not converted here: the standalone .so/program variants of lef/plot/router/ext2spice/ext2sim (their module libs do build), the disabled oa module (-I. -> -I$(srcdir) still needed if enabled), the WASM path, and doc/latexfiles PostScript *regeneration* (which still writes into the source psfiles dir). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 14:59:44 +02:00
PS_SRCDIR=${MAGICSRC}/doc/psfiles
build: out-of-tree .so variants, oa, and latexfiles PS regen Extend the out-of-tree build to the outliers deferred earlier, and audit install sourcing. All are read-source / write-build now. Tcl auto-load shared libraries (built via each module's `tcl-main`; not part of the default TCL build, but now correct when invoked): * lef/plot/router/ext2spice/ext2sim: the hand-written object rules (tcllef.o, tclplot.o, tclroute.o, spicewrap.o, spicehier.o, simwrap.o, ext2sim_main.o) compiled a bare-name source from the cwd; switch to `-c $< -o $@` so the source is found via VPATH and the object lands in the build tree. ext2sim_main.o also swaps the hard-coded -I${MAGICDIR} for ${CPPFLAGS} (build + source include paths). ext2spice spice2sim install copies $< (source script). Sibling ${MAGICDIR}/<mod>/lib*.o refs already resolve into the build tree (MAGICDIR = build top). oa (disabled by default; OpenAccess): * CXX_INCLUDES -I. -> -I$(srcdir) -I${MAGICDIR} -I${MAGICSRC} so the C++ sources, generated database/database.h, and cross-module headers all resolve out-of-tree; .deps and objects were already build-local. doc/latexfiles PostScript regeneration: * Split PS_SRCDIR (pre-built PS shipped in the source tree, read-only) from PS_GENDIR (= psfiles in the build tree). `all` / the .tex.ps rule now regenerate into PS_GENDIR (mkdir -p; latex reads $(srcdir) via TEXINPUTS; dvips writes the build tree) instead of writing back into the source psfiles dir. install takes each .ps from PS_GENDIR if regenerated there, else the pre-built PS_SRCDIR copy. Verified out-of-tree (make modules; then per-module tcl-main): * magiclef.so / tclplot.so / tclroute.so / exttospice.so / exttosim.so all build into the build tree (rc=0); oa.o builds into the build tree; source tree stays clean. * install-tcl copies each .so from the build tree. * Install-location audit on a full `make install DESTDIR=...`: generated data (scmos.tech, .magicrc, magic.tcl, tclmagic.so) matches the build tree; verbatim data (glyphs, fonts, magicps.pro, man pages, doc PS) matches the source tree. * DESTDIR: two distinct prefixes install 376 files each, independent and fully contained (nothing written outside DESTDIR). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 15:39:35 +02:00
PS_GENDIR=psfiles
PS_INSTDIR=$(INSTALL_LIBDIR)/magic/doc
.SUFFIXES: .dvi .tex .ps
GENDVI=tut1.dvi tut2.dvi tut3.dvi tut4.dvi tut5.dvi tut6.dvi \
tut7.dvi tut8.dvi tut9.dvi tut10.dvi tut11.dvi \
maint1.dvi maint2.dvi maint3.dvi maint4.dvi \
introduction.dvi copyright.dvi addendum6_5.dvi \
tutscm1.dvi tutscm2.dvi tutscm3.dvi tutscm4.dvi \
tuttcl1.dvi tuttcl2.dvi tuttcl3.dvi tuttcl4.dvi tuttcl5.dvi \
tutwrl1.dvi
GENPS=tut1.ps tut2.ps tut3.ps tut4.ps tut5.ps tut6.ps \
tut7.ps tut8.ps tut9.ps tut10.ps tut11.ps \
maint1.ps maint2.ps maint3.ps maint4.ps \
introduction.ps copyright.ps addendum6_5.ps \
tutscm1.ps tutscm2.ps tutscm3.ps tutscm4.ps \
tuttcl1.ps tuttcl2.ps tuttcl3.ps tuttcl4.ps tuttcl5.ps \
tutwrl1.ps
build: out-of-tree .so variants, oa, and latexfiles PS regen Extend the out-of-tree build to the outliers deferred earlier, and audit install sourcing. All are read-source / write-build now. Tcl auto-load shared libraries (built via each module's `tcl-main`; not part of the default TCL build, but now correct when invoked): * lef/plot/router/ext2spice/ext2sim: the hand-written object rules (tcllef.o, tclplot.o, tclroute.o, spicewrap.o, spicehier.o, simwrap.o, ext2sim_main.o) compiled a bare-name source from the cwd; switch to `-c $< -o $@` so the source is found via VPATH and the object lands in the build tree. ext2sim_main.o also swaps the hard-coded -I${MAGICDIR} for ${CPPFLAGS} (build + source include paths). ext2spice spice2sim install copies $< (source script). Sibling ${MAGICDIR}/<mod>/lib*.o refs already resolve into the build tree (MAGICDIR = build top). oa (disabled by default; OpenAccess): * CXX_INCLUDES -I. -> -I$(srcdir) -I${MAGICDIR} -I${MAGICSRC} so the C++ sources, generated database/database.h, and cross-module headers all resolve out-of-tree; .deps and objects were already build-local. doc/latexfiles PostScript regeneration: * Split PS_SRCDIR (pre-built PS shipped in the source tree, read-only) from PS_GENDIR (= psfiles in the build tree). `all` / the .tex.ps rule now regenerate into PS_GENDIR (mkdir -p; latex reads $(srcdir) via TEXINPUTS; dvips writes the build tree) instead of writing back into the source psfiles dir. install takes each .ps from PS_GENDIR if regenerated there, else the pre-built PS_SRCDIR copy. Verified out-of-tree (make modules; then per-module tcl-main): * magiclef.so / tclplot.so / tclroute.so / exttospice.so / exttosim.so all build into the build tree (rc=0); oa.o builds into the build tree; source tree stays clean. * install-tcl copies each .so from the build tree. * Install-location audit on a full `make install DESTDIR=...`: generated data (scmos.tech, .magicrc, magic.tcl, tclmagic.so) matches the build tree; verbatim data (glyphs, fonts, magicps.pro, man pages, doc PS) matches the source tree. * DESTDIR: two distinct prefixes install 376 files each, independent and fully contained (nothing written outside DESTDIR). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 15:39:35 +02:00
GEN_GENPS= $(GENPS:%=${PS_GENDIR}/%)
INST_GENPS= $(GENPS:%=$(DESTDIR)${PS_INSTDIR}/%)
build: out-of-tree .so variants, oa, and latexfiles PS regen Extend the out-of-tree build to the outliers deferred earlier, and audit install sourcing. All are read-source / write-build now. Tcl auto-load shared libraries (built via each module's `tcl-main`; not part of the default TCL build, but now correct when invoked): * lef/plot/router/ext2spice/ext2sim: the hand-written object rules (tcllef.o, tclplot.o, tclroute.o, spicewrap.o, spicehier.o, simwrap.o, ext2sim_main.o) compiled a bare-name source from the cwd; switch to `-c $< -o $@` so the source is found via VPATH and the object lands in the build tree. ext2sim_main.o also swaps the hard-coded -I${MAGICDIR} for ${CPPFLAGS} (build + source include paths). ext2spice spice2sim install copies $< (source script). Sibling ${MAGICDIR}/<mod>/lib*.o refs already resolve into the build tree (MAGICDIR = build top). oa (disabled by default; OpenAccess): * CXX_INCLUDES -I. -> -I$(srcdir) -I${MAGICDIR} -I${MAGICSRC} so the C++ sources, generated database/database.h, and cross-module headers all resolve out-of-tree; .deps and objects were already build-local. doc/latexfiles PostScript regeneration: * Split PS_SRCDIR (pre-built PS shipped in the source tree, read-only) from PS_GENDIR (= psfiles in the build tree). `all` / the .tex.ps rule now regenerate into PS_GENDIR (mkdir -p; latex reads $(srcdir) via TEXINPUTS; dvips writes the build tree) instead of writing back into the source psfiles dir. install takes each .ps from PS_GENDIR if regenerated there, else the pre-built PS_SRCDIR copy. Verified out-of-tree (make modules; then per-module tcl-main): * magiclef.so / tclplot.so / tclroute.so / exttospice.so / exttosim.so all build into the build tree (rc=0); oa.o builds into the build tree; source tree stays clean. * install-tcl copies each .so from the build tree. * Install-location audit on a full `make install DESTDIR=...`: generated data (scmos.tech, .magicrc, magic.tcl, tclmagic.so) matches the build tree; verbatim data (glyphs, fonts, magicps.pro, man pages, doc PS) matches the source tree. * DESTDIR: two distinct prefixes install 376 files each, independent and fully contained (nothing written outside DESTDIR). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 15:39:35 +02:00
# Regenerate all PostScript into the build tree (${PS_GENDIR}).
all: $(GEN_GENPS)
@${RM} $(GENDVI) *.log *.aux
install: $(DESTDIR)${PS_INSTDIR} ${INST_GENPS}
$(DESTDIR)${PS_INSTDIR}: make-doc-dir
make-doc-dir:
${SCRIPTS}/mkdirs $(DESTDIR)${PS_INSTDIR}
build: out-of-tree .so variants, oa, and latexfiles PS regen Extend the out-of-tree build to the outliers deferred earlier, and audit install sourcing. All are read-source / write-build now. Tcl auto-load shared libraries (built via each module's `tcl-main`; not part of the default TCL build, but now correct when invoked): * lef/plot/router/ext2spice/ext2sim: the hand-written object rules (tcllef.o, tclplot.o, tclroute.o, spicewrap.o, spicehier.o, simwrap.o, ext2sim_main.o) compiled a bare-name source from the cwd; switch to `-c $< -o $@` so the source is found via VPATH and the object lands in the build tree. ext2sim_main.o also swaps the hard-coded -I${MAGICDIR} for ${CPPFLAGS} (build + source include paths). ext2spice spice2sim install copies $< (source script). Sibling ${MAGICDIR}/<mod>/lib*.o refs already resolve into the build tree (MAGICDIR = build top). oa (disabled by default; OpenAccess): * CXX_INCLUDES -I. -> -I$(srcdir) -I${MAGICDIR} -I${MAGICSRC} so the C++ sources, generated database/database.h, and cross-module headers all resolve out-of-tree; .deps and objects were already build-local. doc/latexfiles PostScript regeneration: * Split PS_SRCDIR (pre-built PS shipped in the source tree, read-only) from PS_GENDIR (= psfiles in the build tree). `all` / the .tex.ps rule now regenerate into PS_GENDIR (mkdir -p; latex reads $(srcdir) via TEXINPUTS; dvips writes the build tree) instead of writing back into the source psfiles dir. install takes each .ps from PS_GENDIR if regenerated there, else the pre-built PS_SRCDIR copy. Verified out-of-tree (make modules; then per-module tcl-main): * magiclef.so / tclplot.so / tclroute.so / exttospice.so / exttosim.so all build into the build tree (rc=0); oa.o builds into the build tree; source tree stays clean. * install-tcl copies each .so from the build tree. * Install-location audit on a full `make install DESTDIR=...`: generated data (scmos.tech, .magicrc, magic.tcl, tclmagic.so) matches the build tree; verbatim data (glyphs, fonts, magicps.pro, man pages, doc PS) matches the source tree. * DESTDIR: two distinct prefixes install 376 files each, independent and fully contained (nothing written outside DESTDIR). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 15:39:35 +02:00
# Install each PostScript file from the build tree if it was regenerated there,
# otherwise from the pre-built copy shipped in the source tree.
$(DESTDIR)${PS_INSTDIR}/%: $(DESTDIR)${PS_INSTDIR}
@f=${PS_GENDIR}/$*; test -f $$f || f=${PS_SRCDIR}/$*; \
echo "${CP} $$f $(DESTDIR)${PS_INSTDIR}/$*"; \
${CP} $$f $(DESTDIR)${PS_INSTDIR}/$*
build: out-of-tree .so variants, oa, and latexfiles PS regen Extend the out-of-tree build to the outliers deferred earlier, and audit install sourcing. All are read-source / write-build now. Tcl auto-load shared libraries (built via each module's `tcl-main`; not part of the default TCL build, but now correct when invoked): * lef/plot/router/ext2spice/ext2sim: the hand-written object rules (tcllef.o, tclplot.o, tclroute.o, spicewrap.o, spicehier.o, simwrap.o, ext2sim_main.o) compiled a bare-name source from the cwd; switch to `-c $< -o $@` so the source is found via VPATH and the object lands in the build tree. ext2sim_main.o also swaps the hard-coded -I${MAGICDIR} for ${CPPFLAGS} (build + source include paths). ext2spice spice2sim install copies $< (source script). Sibling ${MAGICDIR}/<mod>/lib*.o refs already resolve into the build tree (MAGICDIR = build top). oa (disabled by default; OpenAccess): * CXX_INCLUDES -I. -> -I$(srcdir) -I${MAGICDIR} -I${MAGICSRC} so the C++ sources, generated database/database.h, and cross-module headers all resolve out-of-tree; .deps and objects were already build-local. doc/latexfiles PostScript regeneration: * Split PS_SRCDIR (pre-built PS shipped in the source tree, read-only) from PS_GENDIR (= psfiles in the build tree). `all` / the .tex.ps rule now regenerate into PS_GENDIR (mkdir -p; latex reads $(srcdir) via TEXINPUTS; dvips writes the build tree) instead of writing back into the source psfiles dir. install takes each .ps from PS_GENDIR if regenerated there, else the pre-built PS_SRCDIR copy. Verified out-of-tree (make modules; then per-module tcl-main): * magiclef.so / tclplot.so / tclroute.so / exttospice.so / exttosim.so all build into the build tree (rc=0); oa.o builds into the build tree; source tree stays clean. * install-tcl copies each .so from the build tree. * Install-location audit on a full `make install DESTDIR=...`: generated data (scmos.tech, .magicrc, magic.tcl, tclmagic.so) matches the build tree; verbatim data (glyphs, fonts, magicps.pro, man pages, doc PS) matches the source tree. * DESTDIR: two distinct prefixes install 376 files each, independent and fully contained (nothing written outside DESTDIR). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 15:39:35 +02:00
# Regenerate a .ps (into the build tree) from its .tex (in the source tree).
# Several .tex include figures as ../psfigures/*.ps (relative to this dir). Out
# of tree that path resolves into the empty build tree, so point the build-tree
# ../psfigures at the source copy; both latex and dvips then find the figures and
# outputs stay in-build. This is a shell test (not a make prerequisite) on
# purpose: VPATH would otherwise "find" ../psfigures in the source tree and skip
# creating the build-tree link that latex actually needs.
# * `test -d ../psfigures` is true both in-tree (it is the real source dir) and
# once the build-tree symlink exists, so the link is created only when absent
# and the in-tree source directory is never touched.
# * `ln -sfn` (force + no-dereference) makes creation race-safe: if a parallel
# job already made the symlink, it is replaced in place rather than nested
# inside it (the old `ln -s DIR symlink-to-dir` bug that wrote a stray
# doc/psfigures/psfigures into the source tree).
build: out-of-tree .so variants, oa, and latexfiles PS regen Extend the out-of-tree build to the outliers deferred earlier, and audit install sourcing. All are read-source / write-build now. Tcl auto-load shared libraries (built via each module's `tcl-main`; not part of the default TCL build, but now correct when invoked): * lef/plot/router/ext2spice/ext2sim: the hand-written object rules (tcllef.o, tclplot.o, tclroute.o, spicewrap.o, spicehier.o, simwrap.o, ext2sim_main.o) compiled a bare-name source from the cwd; switch to `-c $< -o $@` so the source is found via VPATH and the object lands in the build tree. ext2sim_main.o also swaps the hard-coded -I${MAGICDIR} for ${CPPFLAGS} (build + source include paths). ext2spice spice2sim install copies $< (source script). Sibling ${MAGICDIR}/<mod>/lib*.o refs already resolve into the build tree (MAGICDIR = build top). oa (disabled by default; OpenAccess): * CXX_INCLUDES -I. -> -I$(srcdir) -I${MAGICDIR} -I${MAGICSRC} so the C++ sources, generated database/database.h, and cross-module headers all resolve out-of-tree; .deps and objects were already build-local. doc/latexfiles PostScript regeneration: * Split PS_SRCDIR (pre-built PS shipped in the source tree, read-only) from PS_GENDIR (= psfiles in the build tree). `all` / the .tex.ps rule now regenerate into PS_GENDIR (mkdir -p; latex reads $(srcdir) via TEXINPUTS; dvips writes the build tree) instead of writing back into the source psfiles dir. install takes each .ps from PS_GENDIR if regenerated there, else the pre-built PS_SRCDIR copy. Verified out-of-tree (make modules; then per-module tcl-main): * magiclef.so / tclplot.so / tclroute.so / exttospice.so / exttosim.so all build into the build tree (rc=0); oa.o builds into the build tree; source tree stays clean. * install-tcl copies each .so from the build tree. * Install-location audit on a full `make install DESTDIR=...`: generated data (scmos.tech, .magicrc, magic.tcl, tclmagic.so) matches the build tree; verbatim data (glyphs, fonts, magicps.pro, man pages, doc PS) matches the source tree. * DESTDIR: two distinct prefixes install 376 files each, independent and fully contained (nothing written outside DESTDIR). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 15:39:35 +02:00
${PS_GENDIR}/%.ps: %.tex
@mkdir -p ${PS_GENDIR}
@test -d ../psfigures || ln -sfn ${MAGICSRC}/doc/psfigures ../psfigures
@echo "Converting $*.tex -> $*.dvi"
build: auto-detect latex/dvips and regenerate docs in default make When latex and dvips are available, the default no-arg "make" now regenerates the PostScript documentation from its .tex sources into the build tree; otherwise the pre-built PostScript shipped in the source tree is used as-is at install time. Documentation is always available either way -- installing latex simply refreshes it from source. configure (scripts/configure.in, regenerated scripts/configure): * AC_PATH_PROG for latex + dvips; DOCS_TARGET = "docs" only when both are found; AC_SUBST(LATEX/DVIPS/DOCS_TARGET). * Configuration summary prints "LaTeX docs: yes/no". scripts/defs.mak.in: export LATEX/DVIPS. Makefile.in: * all: ... $(DOCS_TARGET) -- pulls in "docs" only when latex was found. * docs: best-effort -- `make -k` + a warning on failure so a document that will not typeset (or a missing texlive package) never fails the build; install falls back to the pre-built PostScript for those. doc/latexfiles/Makefile: * use ${LATEX}/${DVIPS} from defs.mak. * the .tex include figures as ../psfigures/*.ps; point the build-tree ../psfigures at ${MAGICSRC}/doc/psfigures (no-op in-tree) so latex and dvips find them while outputs stay in the build tree. CI: main.yml and main-aarch64.yml install texlive-latex-base/-recommended + texlive-fonts-recommended so the Linux builds exercise doc regeneration (best-effort, never fatal). README.Tcl: document latex/dvips as an optional prerequisite for docs. .gitignore: ignore in-tree doc build artifacts (doc/latexfiles/psfiles/, *.dvi/*.aux/*.log); the pre-built doc/psfiles/ stays tracked. Verified out-of-tree with TeX Live 2024: configure reports "LaTeX docs: yes"; `make` regenerates 27/28 documents into the build tree (maint1.tex has a genuine LaTeX error and falls back), stays exit 0; `make install` installs the 27 regenerated PostScript from the build tree and maint1 from the source pre-built copy; the source tree is not modified. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 17:02:51 +02:00
@TEXINPUTS=$(srcdir): ${LATEX} $(srcdir)/$*.tex < /dev/null > /dev/null
@if grep 'LaTeX Warn' $*.log; \
then \
echo "Detected warnings, doing second pass for $*...";\
build: auto-detect latex/dvips and regenerate docs in default make When latex and dvips are available, the default no-arg "make" now regenerates the PostScript documentation from its .tex sources into the build tree; otherwise the pre-built PostScript shipped in the source tree is used as-is at install time. Documentation is always available either way -- installing latex simply refreshes it from source. configure (scripts/configure.in, regenerated scripts/configure): * AC_PATH_PROG for latex + dvips; DOCS_TARGET = "docs" only when both are found; AC_SUBST(LATEX/DVIPS/DOCS_TARGET). * Configuration summary prints "LaTeX docs: yes/no". scripts/defs.mak.in: export LATEX/DVIPS. Makefile.in: * all: ... $(DOCS_TARGET) -- pulls in "docs" only when latex was found. * docs: best-effort -- `make -k` + a warning on failure so a document that will not typeset (or a missing texlive package) never fails the build; install falls back to the pre-built PostScript for those. doc/latexfiles/Makefile: * use ${LATEX}/${DVIPS} from defs.mak. * the .tex include figures as ../psfigures/*.ps; point the build-tree ../psfigures at ${MAGICSRC}/doc/psfigures (no-op in-tree) so latex and dvips find them while outputs stay in the build tree. CI: main.yml and main-aarch64.yml install texlive-latex-base/-recommended + texlive-fonts-recommended so the Linux builds exercise doc regeneration (best-effort, never fatal). README.Tcl: document latex/dvips as an optional prerequisite for docs. .gitignore: ignore in-tree doc build artifacts (doc/latexfiles/psfiles/, *.dvi/*.aux/*.log); the pre-built doc/psfiles/ stays tracked. Verified out-of-tree with TeX Live 2024: configure reports "LaTeX docs: yes"; `make` regenerates 27/28 documents into the build tree (maint1.tex has a genuine LaTeX error and falls back), stays exit 0; `make install` installs the 27 regenerated PostScript from the build tree and maint1 from the source pre-built copy; the source tree is not modified. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 17:02:51 +02:00
TEXINPUTS=$(srcdir): ${LATEX} $(srcdir)/$*.tex < /dev/null > /dev/null; \
(grep 'LaTeX Warn' $*.log || (echo > /dev/null)); \
echo; \
fi
build: out-of-tree .so variants, oa, and latexfiles PS regen Extend the out-of-tree build to the outliers deferred earlier, and audit install sourcing. All are read-source / write-build now. Tcl auto-load shared libraries (built via each module's `tcl-main`; not part of the default TCL build, but now correct when invoked): * lef/plot/router/ext2spice/ext2sim: the hand-written object rules (tcllef.o, tclplot.o, tclroute.o, spicewrap.o, spicehier.o, simwrap.o, ext2sim_main.o) compiled a bare-name source from the cwd; switch to `-c $< -o $@` so the source is found via VPATH and the object lands in the build tree. ext2sim_main.o also swaps the hard-coded -I${MAGICDIR} for ${CPPFLAGS} (build + source include paths). ext2spice spice2sim install copies $< (source script). Sibling ${MAGICDIR}/<mod>/lib*.o refs already resolve into the build tree (MAGICDIR = build top). oa (disabled by default; OpenAccess): * CXX_INCLUDES -I. -> -I$(srcdir) -I${MAGICDIR} -I${MAGICSRC} so the C++ sources, generated database/database.h, and cross-module headers all resolve out-of-tree; .deps and objects were already build-local. doc/latexfiles PostScript regeneration: * Split PS_SRCDIR (pre-built PS shipped in the source tree, read-only) from PS_GENDIR (= psfiles in the build tree). `all` / the .tex.ps rule now regenerate into PS_GENDIR (mkdir -p; latex reads $(srcdir) via TEXINPUTS; dvips writes the build tree) instead of writing back into the source psfiles dir. install takes each .ps from PS_GENDIR if regenerated there, else the pre-built PS_SRCDIR copy. Verified out-of-tree (make modules; then per-module tcl-main): * magiclef.so / tclplot.so / tclroute.so / exttospice.so / exttosim.so all build into the build tree (rc=0); oa.o builds into the build tree; source tree stays clean. * install-tcl copies each .so from the build tree. * Install-location audit on a full `make install DESTDIR=...`: generated data (scmos.tech, .magicrc, magic.tcl, tclmagic.so) matches the build tree; verbatim data (glyphs, fonts, magicps.pro, man pages, doc PS) matches the source tree. * DESTDIR: two distinct prefixes install 376 files each, independent and fully contained (nothing written outside DESTDIR). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 15:39:35 +02:00
@echo "Converting $*.dvi -> ${PS_GENDIR}/$*.ps"
build: auto-detect latex/dvips and regenerate docs in default make When latex and dvips are available, the default no-arg "make" now regenerates the PostScript documentation from its .tex sources into the build tree; otherwise the pre-built PostScript shipped in the source tree is used as-is at install time. Documentation is always available either way -- installing latex simply refreshes it from source. configure (scripts/configure.in, regenerated scripts/configure): * AC_PATH_PROG for latex + dvips; DOCS_TARGET = "docs" only when both are found; AC_SUBST(LATEX/DVIPS/DOCS_TARGET). * Configuration summary prints "LaTeX docs: yes/no". scripts/defs.mak.in: export LATEX/DVIPS. Makefile.in: * all: ... $(DOCS_TARGET) -- pulls in "docs" only when latex was found. * docs: best-effort -- `make -k` + a warning on failure so a document that will not typeset (or a missing texlive package) never fails the build; install falls back to the pre-built PostScript for those. doc/latexfiles/Makefile: * use ${LATEX}/${DVIPS} from defs.mak. * the .tex include figures as ../psfigures/*.ps; point the build-tree ../psfigures at ${MAGICSRC}/doc/psfigures (no-op in-tree) so latex and dvips find them while outputs stay in the build tree. CI: main.yml and main-aarch64.yml install texlive-latex-base/-recommended + texlive-fonts-recommended so the Linux builds exercise doc regeneration (best-effort, never fatal). README.Tcl: document latex/dvips as an optional prerequisite for docs. .gitignore: ignore in-tree doc build artifacts (doc/latexfiles/psfiles/, *.dvi/*.aux/*.log); the pre-built doc/psfiles/ stays tracked. Verified out-of-tree with TeX Live 2024: configure reports "LaTeX docs: yes"; `make` regenerates 27/28 documents into the build tree (maint1.tex has a genuine LaTeX error and falls back), stays exit 0; `make install` installs the 27 regenerated PostScript from the build tree and maint1 from the source pre-built copy; the source tree is not modified. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 17:02:51 +02:00
@${DVIPS} -t letter $*.dvi -o ${PS_GENDIR}/$*.ps > /dev/null
clean:
build: out-of-tree .so variants, oa, and latexfiles PS regen Extend the out-of-tree build to the outliers deferred earlier, and audit install sourcing. All are read-source / write-build now. Tcl auto-load shared libraries (built via each module's `tcl-main`; not part of the default TCL build, but now correct when invoked): * lef/plot/router/ext2spice/ext2sim: the hand-written object rules (tcllef.o, tclplot.o, tclroute.o, spicewrap.o, spicehier.o, simwrap.o, ext2sim_main.o) compiled a bare-name source from the cwd; switch to `-c $< -o $@` so the source is found via VPATH and the object lands in the build tree. ext2sim_main.o also swaps the hard-coded -I${MAGICDIR} for ${CPPFLAGS} (build + source include paths). ext2spice spice2sim install copies $< (source script). Sibling ${MAGICDIR}/<mod>/lib*.o refs already resolve into the build tree (MAGICDIR = build top). oa (disabled by default; OpenAccess): * CXX_INCLUDES -I. -> -I$(srcdir) -I${MAGICDIR} -I${MAGICSRC} so the C++ sources, generated database/database.h, and cross-module headers all resolve out-of-tree; .deps and objects were already build-local. doc/latexfiles PostScript regeneration: * Split PS_SRCDIR (pre-built PS shipped in the source tree, read-only) from PS_GENDIR (= psfiles in the build tree). `all` / the .tex.ps rule now regenerate into PS_GENDIR (mkdir -p; latex reads $(srcdir) via TEXINPUTS; dvips writes the build tree) instead of writing back into the source psfiles dir. install takes each .ps from PS_GENDIR if regenerated there, else the pre-built PS_SRCDIR copy. Verified out-of-tree (make modules; then per-module tcl-main): * magiclef.so / tclplot.so / tclroute.so / exttospice.so / exttosim.so all build into the build tree (rc=0); oa.o builds into the build tree; source tree stays clean. * install-tcl copies each .so from the build tree. * Install-location audit on a full `make install DESTDIR=...`: generated data (scmos.tech, .magicrc, magic.tcl, tclmagic.so) matches the build tree; verbatim data (glyphs, fonts, magicps.pro, man pages, doc PS) matches the source tree. * DESTDIR: two distinct prefixes install 376 files each, independent and fully contained (nothing written outside DESTDIR). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-22 15:39:35 +02:00
${RM} $(GENDVI) $(GEN_GENPS) *.log *.aux