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

Better showing of #include #7648

Merged
merged 2 commits into from
Sep 7, 2023

Conversation

albert-github
Copy link
Contributor

Getting a better (and consistent) output for the include file to be used with some functions. Normally #include are sown as in a typewrite font, but the #include in these cases were shown in a code block way.

For e.g Weights/group__PkgWeightsRefUniformRegionWeights.htmlthe w`#include was shown as:
image

and will now be shown as:
image

Getting a better (and consistent) output for the include file to be used with some functions.
Normally `#include` are sown as in a typewrite font, but the `#include` in these cases were shown in a code block way.
@sloriot
Copy link
Member

sloriot commented Aug 17, 2023

CGAL-6.0-Ic-42 shows new warnings with doxygen 1.8.13 with those changes.

@albert-github
Copy link
Contributor Author

I think we can ignore these as I think the doxygen version 1.8.13 won't be used anymore for the CGAL 6.0 version as here at least the version 1.9.6 will be used (so no backport).

@albert-github
Copy link
Contributor Author

albert-github commented Aug 17, 2023

Also a bit strange for me is that the CGAL-6.0-Ic-42 exhibits the problem and CGAL-6.0-Ic-43 doesn't though as far as I can see both versions included this proposed patch about #include.

Edit looks like in CGAL-6.0-Ic-43the patch is not tested (though I don't see this reflected in the labels with this issue...)

@sloriot
Copy link
Member

sloriot commented Aug 17, 2023

CGAL-6.0-Ic-43 only has #7526

@albert-github
Copy link
Contributor Author

Explains why the CGAL-6.0-Ic-43 doesn't have the problem, though from the, last, label actions I see:
image

which gave the impression to me, as layman, that the PR #7648 is also included in the test.
(still the remark about the used doxygen versions stands, and has in my opinion a higher relevance than the warnings generated).

@sloriot
Copy link
Member

sloriot commented Aug 17, 2023

I'm currently using 2 batches, I'm alternating them.

@albert-github
Copy link
Contributor Author

Ahh that explains it.

@albert-github
Copy link
Contributor Author

albert-github commented Aug 17, 2023

Is there a way so we can see what is tested i.e.:

  • what is the base CGAL version tested (i.e. the hash value)
  • the pull requests that are tested

(I once saw the labels "Batch_1" and "Batch_2" but they are hardly applied and don't see them at all with the current "Under testing").

@sloriot
Copy link
Member

sloriot commented Aug 18, 2023

If you click on a test result, you see the list of PRs merged at the top of the page. For example here.

@albert-github
Copy link
Contributor Author

albert-github commented Aug 18, 2023

I nearly finished my reply (I just leave it as a sort of reference) when I got a "brainwave" that there might exist a page https://cgal.geometryfactory.com/CGAL/testsuite analogous to the https://cgal.geometryfactory.com/CGAL/Manual_doxygen_test/page that might give direct access to the information I described and indeed it was present and gives even more selection possibilities.
So I now created a shortcut for myself and can easily visit it.
(As far as I can tell the information is only present for the MSVC tests (edit not true as I see in the long table below the information direct clickable and in the top table in the different parts one has to scroll a bit more down) but that is all sufficient for me).

Thanks for the information and the patience about these questions.

At the top this is the information I requested, though you mentioned the link:

that it is "just" for the AABB_tree is not a problem as at the top of the page this information is present, though there is no reference to the mentioned page on:

So it is still a bit an educational guess to get the correct link (i.e. changing the CGAL-6.0-Ic-44 and in future the part Christo_MSVC-2022-Community-Release.
So in my opinion it would be nice to have the "top" information available directly through a link at the page https://cgal.geometryfactory.com/CGAL/Manual_doxygen_test/ or to have an extra column in the documentation page.

@sloriot
Copy link
Member

sloriot commented Aug 18, 2023

I agree that this information should be directly available in the testsuite landing page, especially because now we only merge pull requests, we could only the list of PR + hash. Let's create an issue for that.

@albert-github
Copy link
Contributor Author

albert-github commented Aug 18, 2023

Will you create an issue or should I try to do it. #7654

@sloriot
Copy link
Member

sloriot commented Sep 6, 2023

Successfully tested in CGAL-6.0-Ic-56

@lrineau lrineau self-assigned this Sep 6, 2023
@lrineau lrineau added this to the 6.0-beta milestone Sep 6, 2023
@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 Sep 6, 2023
@lrineau lrineau merged commit c50c72f into CGAL:master Sep 7, 2023
9 checks passed
@albert-github albert-github deleted the feature/bug_pkgdesc_incl branch September 7, 2023 09:08
@lrineau lrineau removed the rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' label Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants