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

Overview of changes in GAP 4.9.1 release #2418

Merged
merged 1 commit into from
May 4, 2018

Conversation

olexandr-konovalov
Copy link
Member

@olexandr-konovalov olexandr-konovalov commented Apr 27, 2018

This PR adds new Chapter to the Changes manual. It is based on wiki page https://github.com/gap-system/gap/wiki/GAP-4.9-release-notes

@codecov
Copy link

codecov bot commented Apr 27, 2018

Codecov Report

Merging #2418 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2418   +/-   ##
=======================================
  Coverage   73.96%   73.96%           
=======================================
  Files         484      484           
  Lines      245454   245454           
=======================================
  Hits       181541   181541           
  Misses      63913    63913
Impacted Files Coverage Δ
src/gasman.c 85.37% <0%> (-0.19%) ⬇️
src/hpc/threadapi.c 43.3% <0%> (-0.11%) ⬇️
src/objset.c 84.82% <0%> (+0.22%) ⬆️
hpcgap/lib/hpc/stdtasks.g 64.96% <0%> (+0.25%) ⬆️

(but not yet all: help with this is welcome). Some relevant pull requests:
<List>
<Item>
<!-- [#1165](https://github.com/gap-system/gap/pull/1165) -->
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps these should be turned into actual hyperlinks? E.g. at the end of each entry, have something like (#1234, #1236) with both PR numbers hyperlinks.

Copy link
Member Author

@olexandr-konovalov olexandr-konovalov Apr 28, 2018

Choose a reason for hiding this comment

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

Yes, I had actually a similar thought - good to see someone else expressing it too... Some places already got text like (For some technical details, +see <URL Text="#609">https://github.com/gap-system/gap/pull/609</URL>). - I am all for doing this for the rest. This will be especially helpful when the description is less than informative or sounds too similar to another entry.

@olexandr-konovalov olexandr-konovalov force-pushed the changes-4.9.1 branch 2 times, most recently from be83fb0 to 4ad909d Compare May 1, 2018 22:33
@olexandr-konovalov
Copy link
Member Author

Making PDF version currently produces a number of messages

! You can't use `macro parameter character #' in horizontal mode.
<argument> ##

because it trips over # in

<URL Text="#490">https://github.com/gap-system/gap/pull/490</URL>)

I've figured out that one can do

<URL><LinkText><Alt Only="LaTeX">\\</Alt>#484</LinkText><Link>https://github.com/gap-system/gap/pull/484</Link></URL>

and then hash appears in PDF, but from a new line. Not sure what to do except ignoring LaTeX warnings and not having hashes in the PDF version of the manual.

@olexandr-konovalov
Copy link
Member Author

Thanks @fingolfin - a combination of

<!ENTITY Hash  "<Alt Only='LaTeX'>\#</Alt><Alt Not='LaTeX'>#</Alt>">

and

<URL><LinkText>&Hash;484</LinkText><Link>https://github.com/gap-system/gap/pull/484</Link></URL>

resolves this.

@olexandr-konovalov
Copy link
Member Author

olexandr-konovalov commented May 2, 2018

This seems to be ready for the reviewing, but may later require some updates related to #2431. Also, I will have to update URL elements to use &Hash; as shown above, but if anyone would like to loom at the text in the meantime, please go ahead!

<Item>
In addition to supporting single argument lambda functions like
<C>a -> a+1</C>, &GAP; now supports lambdas with fewer or more than
one argument, or even an arbitrary number. E.g. <C>{a,b} -> a+b</C>
Copy link
Member

Choose a reason for hiding this comment

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

I think "an arbitrary number" should be changed to "a variable number" (also in the Wiki) for clarity

<C>a -> a+1</C>, &GAP; now supports lambdas with fewer or more than
one argument, or even an arbitrary number. E.g. <C>{a,b} -> a+b</C>
is a shorthand for <C>function(a,b) return a+b; end</C>. For details,
see <Ref BookName="ref" Sect="Function"/>. (For technical details,
Copy link
Member

Choose a reason for hiding this comment

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

Twice "For details", though once "technical"... Perhaps: "For details on how to use this, see REF. For technical details, ..." ?

<URL Text="#490">https://github.com/gap-system/gap/pull/490</URL>).
</Item>
<Item>
Function calls, list accesses and records now can be nested. For example,
Copy link
Member

Choose a reason for hiding this comment

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

change "records" -> "records accesses"

<URL Text="TransGrp">http://www.math.colostate.edu/~hulpke/transgrp/</URL>.
For backwards compatibility, these are required packages in &GAP; 4.9
(i.e., &GAP; will not start without them). We plan to change this for
&GAP; 4.10, once all packages which currently implicitly rely on these
Copy link
Member

Choose a reason for hiding this comment

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

Off-topic, but: Do we have an issue with milestone 4.10 tracking this? E.g. listing all packages that need to be updated; if we have that list, or else a request to create such a list, then notify package authors?

If not, we should perhaps create it, and link to it here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in #2434

<Item>
We removed our old home-grown big integer code, and instead always use the
GMP based big integer code. This means that the GMP library now is a
required dependency, not just an optional one.
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps add:

Note that GAP has been using GMP big integer arithmetic for a long time by default, and we also have been bundling GMP with GAP. So this change mostly removed code that was never in use for most user.

computation, has been added for the redistribution.
<P/>

<Package>HAPprime</Package> package by Paul Smith is no longer redistributed
Copy link
Member

Choose a reason for hiding this comment

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

Add "The" at start of sentence. Also, why is it "XYZ package" here, but "package XYZ" above (different word order)?


<Package>HAPprime</Package> package by Paul Smith is no longer redistributed
with &GAP;. Part of the code has been incorporated into the <Package>HAP</Package>
package. <Package>HAPprime</Package> source code repository could be found at
Copy link
Member

Choose a reason for hiding this comment

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

Add "The" at start of sentence. And replace "could be" by "can still be". Perhaps also insert "containing the code of the last distributed version" somewhere?

<URL>https://github.com/gap-packages/happrime</URL>.
<P/>

Also, <Package>ParGAP</Package> package by Gene Cooperman
Copy link
Member

Choose a reason for hiding this comment

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

again, insert "the" before the package name.

Also, <Package>ParGAP</Package> package by Gene Cooperman
is no longer redistributed with &GAP; (see
<URL Text="this announcement">https://mail.gap-system.org/pipermail/gap/2018-March/001082.html </URL>).
<Package>ParGAP</Package> source code repository could be found at
Copy link
Member

Choose a reason for hiding this comment

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

could -> can; all the same remarks as for HAPPrime apply, though here one could write: "containing the code of the last distributed version, plus some first fixes needed for compatibility for GAP 4.9"?

Copy link
Member

Choose a reason for hiding this comment

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

We could also insert: "If somebody is interested in repairing this package and taking over its maintenance, so that it can be distributed again, please contact the GAP team." ?

<P/>

Also, <Package>ParGAP</Package> package by Gene Cooperman
is no longer redistributed with &GAP; (see
Copy link
Member

Choose a reason for hiding this comment

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

perhaps insert "because it no longer can be compiled with GAP 4.9" before the "(see "

@olexandr-konovalov
Copy link
Member Author

Thank you @fingolfin - pushed new version with updated URL format and your comments taken into account.

@olexandr-konovalov
Copy link
Member Author

As for unresolved links (#2431), tempting to replace them by <C>..</C> today, make 4.9.1 release, and then resolve #2431 in due course, to not to cause any further delays.

(<URL><LinkText>&Hash;1991</LinkText><Link>https://github.com/gap-system/gap/pull/1991</Link></URL>)
</Item>
<Item>
Fix <Ref BookName="ref" Oper="PositionProperty"/> with from &lt; 1
Copy link
Member

Choose a reason for hiding this comment

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

from is an argument, so perhaps <A>from</A>, or at least <C>from</C>

</Item>
<Item>
Fix <Ref BookName="ref" Oper="QuotientMod"/> documentation, and the integer
implementation. This partially reverts changes made in 2013. The documentation
Copy link
Member

Choose a reason for hiding this comment

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

Instead of (or in addition to) saying 2013, let's say this was in version GAP 4.7.8, which I think is more helpful for most people.

@olexandr-konovalov
Copy link
Member Author

Avoided unresolved links and implemented two most recent @fingolfin's suggestions - should be ready for merge.

@fingolfin fingolfin merged commit 0d17ed5 into gap-system:master May 4, 2018
@olexandr-konovalov olexandr-konovalov deleted the changes-4.9.1 branch May 4, 2018 22:19
@fingolfin
Copy link
Member

Was backported in commit d4f7777

@olexandr-konovalov olexandr-konovalov added the release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes label Jun 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes topic: documentation Issues and PRs related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants