Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve support for manuals using old-style gapmacros.tex, doc/make_doc script #57

Open
fingolfin opened this issue Oct 25, 2018 · 0 comments

Comments

@fingolfin
Copy link
Member

Right now, this is a bit of a hack: Those make_doc scripts usually hardcode paths involving ../../... While that can be fixed in various ways, more problematic is that they usually reference the

Thus, running ./make_doc only works if the package either is really inside GAPROOT/pkg/PACKAGE, or else suitable symlinks (to GAPROOT/etc and GAPROOT/doc are created in the right place relative to the make_doc script.

One way to deal with that would be to wrap the package not directly in tmp, but rather in tmp/pkg/, and add the above mentioned symlinks as tmp/doc/ and tmp/etc

Another approach would be to make the ../../.. adjustable (this obviously requires modifying those packages):

  • in make_doc, on could add at the top something like GAPDIR=${GAPDIR:-../../..} (or, for scripts which have a ./configure, the GAPROOT passed to configure could be inserted into the make_doc script)
  • in the TeX code, perhaps the ../../.. could be moved into a tex variable, which can be overridden via an argument to tex. Or for projects with a ./configure, one could have a foo.tex.in file in which @GAPDIR@ is used and substituted appropriately. (But careful: we must make sure that in the final file, references to the GAP manuals are still relative, at least for the release tarball.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant