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.

Sign up for GitHub

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

Remove install-tools.sh and documentation mentioning it #1305

Merged
merged 3 commits into from
Jun 3, 2017
Merged

Remove install-tools.sh and documentation mentioning it #1305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d537cc3
doc/ref/helpintf.xml: remove ref to install-tools.sh, clarify
fingolfin Feb 6, 2017
a48e329
etc/install-tools.sh: remove
fingolfin May 7, 2017
7be16f5
Remove etc/README.tools
fingolfin May 31, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 10 additions & 16 deletions doc/ref/helpintf.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,25 +90,19 @@ any more. The book can be re-installed using <Ref Func="HELP_ADD_BOOK" />. <P/>
<Section Label="The manual.six File">
<Heading>The manual.six File</Heading>

If a <F>manual.six</F> file for a help book is not in the format of the
<F>gapmacro.tex</F> macros, explained in the document
<Q>The gapmacro.tex Manual Format</Q> (see the file
<F>gap4r5/doc/gapmacrodoc.pdf</F> from the tools archive
<C>etc/tools.tar.gz</C> which should be unpacked using the script
<F>etc/install-tools.sh</F>), the first non-empty line of
<F>manual.six</F> must be of the form
The first non-empty line of <F>manual.six</F> should be of the form
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we throw away mentioning of doc/gapmacrodoc.pdf completely (cf. @fingolfin's comment in #1125). What to do with doc/gapmacrodoc.tex itself - does it stay where it is? Do we need to build PDF out of it during the release? I would leave tex for now, but do not build PDF.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed.

<P/>
<C>#SIXFORMAT</C> <A>myownformat</A>
<P/>
where <A>myownformat</A> is an identifying string for this format.
The reading of
the (remainder of the) file is then delegated to the function
<C>HELP_BOOK_HANDLER.<A>myownformat</A>.ReadSix</C> which must exist.
Thus there are
no further regulations for the format of the <F>manual.six</F> file, other that
what you yourself impose. If such a line is missing then it is assumed that
the <F>manual.six</F> file complies with the <F>gapmacro.tex</F> documentation format
which is the <C>default</C> format.
where <A>myownformat</A> is an identifying string for this format. The reading
of the (remainder of the) file is then delegated to the function
<C>HELP_BOOK_HANDLER.<A>myownformat</A>.ReadSix</C> which must exist. Thus
there are no further regulations for the format of the <F>manual.six</F> file,
other that what you yourself impose. If such a line is missing then it is
assumed that the <F>manual.six</F> file complies with the <F>gapmacro.tex</F>
documentation format, which internally is referred to as the <C>default</C>
format for historical reasons. In that case reading the file is delegated to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps I would even say "for legacy reasons", but that's not essential

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to open a new PR which makes that change :-)

<C>HELP_BOOK_HANDLER.default.ReadSix</C>.
<P/>
Section <Ref Sect="The Help Book Handler"/> explains how the return value of
<C>HELP_BOOK_HANDLER.<A>myownformat</A>.ReadSix</C> should look like and which further
Expand Down
42 changes: 0 additions & 42 deletions etc/README.tools
View file
Open in desktop

This file was deleted.

27 changes: 0 additions & 27 deletions etc/install-tools.sh
View file
Open in desktop

This file was deleted.