Skip to content

Fix a number of issues in CHANGES.md and add links for 5.1#4714

Merged
lrineau merged 10 commits intoCGAL:masterfrom
MaelRL:CGAL-Format_CHANGES.md_5.1-GF
Jun 5, 2020
Merged

Fix a number of issues in CHANGES.md and add links for 5.1#4714
lrineau merged 10 commits intoCGAL:masterfrom
MaelRL:CGAL-Format_CHANGES.md_5.1-GF

Conversation

@MaelRL
Copy link
Copy Markdown
Member

@MaelRL MaelRL commented May 9, 2020 •
edited
Loading

Summary of Changes

Fix part of the 5.1 changelog being under a 5.0 tag, removed a bunch of duplicates, reorganized, uniformized, added links.

Online version: https://github.com/MaelRL/cgal/blob/CGAL-Format_CHANGES.md_5.1-GF/Installation/CHANGES.md

TODO:

  • @sloriot: the changelog for AABB tree was wrong (do_not_accelerate_distance_queries was introduced in 5.1), I rewrote it, please check the new version
  • @maxGimeno: the changelog speaks of a free function called CGAL::file_input but it doesn't seem to exist?
  • @sgiraudot: I think we could put at the top (with the new packages) a link to your tutorials, what do you think?
  • @sgiraudot @maxGimeno @lrineau: should there be something at the top in general about all the CMake improvements?
  • any other general changes (supported compilers / lib version changes) ?
  • @MaelRL: Check all the links once 5.1 doc is online.

Release Management

Integrate after remaining PRs that will still modify CHANGES.md (#4568, #4620, #4659)

  • Affected package(s): Installation

@MaelRL MaelRL added the TODO label May 9, 2020
@MaelRL MaelRL added this to the 5.1-beta milestone May 9, 2020
@sloriot sloriot mentioned this pull request May 9, 2020
Closed
79 tasks
@MaelRL MaelRL changed the title Fix a number of issues in CHANGES.md-CGAL 5.1 and add links Fix a number of issues in CHANGES.md and add links May 11, 2020
@MaelRL MaelRL changed the title Fix a number of issues in CHANGES.md and add links Fix a number of issues in CHANGES.md and add links for 5.1 May 25, 2020
@maxGimeno
Copy link
Copy Markdown
Contributor

maxGimeno commented Jun 3, 2020

ping @sgiraudot @MaelRL

@lrineau lrineau mentioned this pull request Jun 3, 2020
Merged
2 tasks
@lrineau
Copy link
Copy Markdown
Member

lrineau commented Jun 3, 2020

The PR #4620 has been merged, without any addition to the CHANGES.md. I suggest it is done in this PR.

@lrineau lrineau added the rm only: release blocker For the release team only: the next release requires this issue/PR to be solved/merge label Jun 3, 2020
@lrineau
Copy link
Copy Markdown
Member

lrineau commented Jun 3, 2020

ping @sgiraudot @MaelRL

That is important. This PR blocks the release of CGAL-5.1-beta1.

@MaelRL
Copy link
Copy Markdown
Member Author

MaelRL commented Jun 3, 2020 •
edited
Loading

I will update the branch, but:

  • The doc for CGAL 5.1 (https://doc.cgal.org/5.1/Manual/index.html) needs to be online before I can do the link checking;
  • Nobody has answered yet about the CMake scripts changes or about bumps-up of third party dependencies / compilers required versions.

@lrineau
Copy link
Copy Markdown
Member

lrineau commented Jun 3, 2020 •
edited
Loading

I will update the branch, but:

* The doc for CGAL 5.1 ([doc.cgal.org/5.1/Manual/index.html](https://doc.cgal.org/5.1/Manual/index.html)) needs to be online before I can do the link checking;

Done: I have uploaded the documentation of CGAL-5.1-I-165 at that URL.

* Nobody has answered yet about the CMake scripts changes or about bumps-up of third party required versions.

I do not think there is anything to report. Do we want to officially document our CMake API? @sgiraudot?

@maxGimeno
Copy link
Copy Markdown
Contributor

maxGimeno commented Jun 3, 2020

  • Nobody has answered yet about the CMake scripts changes or about bumps-up of third party dependencies / compilers required versions.

I don't think either. This is not supposed to change the behaviour, and if it does, there is a warning explaining what to do.

@MaelRL
Copy link
Copy Markdown
Member Author

MaelRL commented Jun 3, 2020

I will update the branch, but:

* The doc for CGAL 5.1 ([doc.cgal.org/5.1/Manual/index.html](https://doc.cgal.org/5.1/Manual/index.html)) needs to be online before I can do the link checking;

Done: I have uploaded the documentation of CGAL-5.1-I-165 at that URL.

Could you please use another release since Tetrahedral Remeshing was not part of that release ?

@lrineau
Copy link
Copy Markdown
Member

lrineau commented Jun 3, 2020

I will update the branch, but:

* The doc for CGAL 5.1 ([doc.cgal.org/5.1/Manual/index.html](https://doc.cgal.org/5.1/Manual/index.html)) needs to be online before I can do the link checking;

Done: I have uploaded the documentation of CGAL-5.1-I-165 at that URL.

Could you please use another release since Tetrahedral Remeshing was not part of that release ?

You are right. It should be fine, now.

@MaelRL
Copy link
Copy Markdown
Member Author

MaelRL commented Jun 3, 2020

I'm done, see https://github.com/MaelRL/cgal/blob/CGAL-Format_CHANGES.md_5.1-GF/Installation/CHANGES.md.

@MaelRL MaelRL removed the TODO label Jun 3, 2020
@sgiraudot
Copy link
Copy Markdown
Contributor

sgiraudot commented Jun 4, 2020 

* Nobody has answered yet about the CMake scripts changes or about bumps-up of third party required versions.

I do not think there is anything to report. Do we want to officially document our CMake API? @sgiraudot?

The previous API was 0% documented so there's no "official" breaking change (and using the old version triggers warning but still works). The new third party imported targets have now a small documentation in the Third Party section of the manual, I think it's enough?

@lrineau lrineau mentioned this pull request Jun 4, 2020
Merged
@maxGimeno
Copy link
Copy Markdown
Contributor

maxGimeno commented Jun 5, 2020

Successfully tested in https://cgal.geometryfactory.com/CGAL/testsuite/results-5.1-Ic-169.shtml

@lrineau lrineau self-assigned this Jun 5, 2020
@lrineau lrineau added the rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' label Jun 5, 2020
@lrineau lrineau merged commit a52a52d into CGAL:master Jun 5, 2020
@lrineau lrineau added Doc and removed Under Testing rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' rm only: release blocker For the release team only: the next release requires this issue/PR to be solved/merge labels Jun 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@lrineau lrineau

Labels

Doc Merged_in_5.1 Tested

Projects

None yet

Milestone

5.1-beta1

Development

Successfully merging this pull request may close these issues.

4 participants

@MaelRL @maxGimeno @lrineau @sgiraudot