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

create dummy images in advance for doxygen not to complain #11614

Closed
wants to merge 1 commit into from

Conversation

ferdymercury
Copy link
Contributor

This Pull request:

Changes or fixes:

Currently, building the documentation issues 3700 warnings, see https://lcgapp-services.cern.ch/root-jenkins/view/ROOT/job/root-makedoc-master/lastBuild/parsed_console/

With the current hack, we would go down to just 2700.

By the way, it would be nice to fine-tune the parser: see root-project/jenkins-pipelines#10

Checklist:

  • tested changes locally
  • updated the docs (if necessary)

See related discussion doxygen/doxygen#9044

@ferdymercury ferdymercury requested a review from couet as a code owner October 19, 2022 18:12
@phsft-bot
Copy link
Collaborator

Starting build on ROOT-debian10-i386/soversion, ROOT-performance-centos8-multicore/cxx17, ROOT-ubuntu18.04/nortcxxmod, ROOT-ubuntu2004/python3, mac1015/cxx17, mac11/cxx14, windows10/cxx14
How to customize builds

@couet
Copy link
Member

couet commented Nov 3, 2022

I see the idea... you are creating empty pictures first just to remove the warnings?

@ferdymercury
Copy link
Contributor Author

Exactly. Just a workaround, in order to be able to focus on the other real warnings.

@couet
Copy link
Member

couet commented Nov 3, 2022

I see the idea. I will try locally

@couet
Copy link
Member

couet commented Nov 3, 2022

The grep is quite long to perform.. it adds 1 minute. Well compared to the whole build it is only a small %.

@couet
Copy link
Member

couet commented Nov 3, 2022

You are looking only for macro_image. This is used only in the tutorials. So you do not need to grep the whole ROOT repository as you do. You need to grep only the tutorials folder.

@couet
Copy link
Member

couet commented Nov 3, 2022

And by the way, I cannot reproduce locally these warnings. For example:

...
Info in <TCanvas::Print>: SVG file mathsymb.svg has been created
Info in <TCanvas::Print>: png file /Users/couet/rootdoc/html/pict1_latex5.C.png has been created
Info in <TCanvas::Print>: ps file mathsymb.ps has been created
...

On the log-ouput you pointed we can see a warning about latex5.C but locally, with a fresh build, it is fine. No warning.

@phsft-bot
Copy link
Collaborator

Starting build on ROOT-debian10-i386/soversion, ROOT-performance-centos8-multicore/cxx17, ROOT-ubuntu18.04/nortcxxmod, ROOT-ubuntu2004/python3, mac1015/cxx17, mac11/cxx14, windows10/cxx14
How to customize builds

@ferdymercury
Copy link
Contributor Author

You are looking only for macro_image. This is used only in the tutorials. So you do not need to grep the whole ROOT repository as you do. You need to grep only the tutorials folder.

Good point. Changed.

@ferdymercury
Copy link
Contributor Author

And by the way, I cannot reproduce locally these warnings. For example:

...
Info in <TCanvas::Print>: SVG file mathsymb.svg has been created
Info in <TCanvas::Print>: png file /Users/couet/rootdoc/html/pict1_latex5.C.png has been created
Info in <TCanvas::Print>: ps file mathsymb.ps has been created
...

On the log-ouput you pointed we can see a warning about latex5.C but locally, with a fresh build, it is fine. No warning.

Maybe it would be useful to add to the Jenkins build a step that cleans the git repository on sftnight before starting the build? To get fresh builds there too?

@phsft-bot
Copy link
Collaborator

Build failed on windows10/cxx14.
Running on null:C:\build\workspace\root-pullrequests-build
See console output.

Failing tests:

@ferdymercury
Copy link
Contributor Author

Maybe it would be useful to add to the Jenkins build a step that cleans the git repository on sftnight before starting the build? To get fresh builds there too?

For example using the git clean command within https://github.com/root-project/rootspi/blob/master/rdoc/preparesource.sh:
https://www.geeksforgeeks.org/git-clean/

@couet
Copy link
Member

couet commented Nov 7, 2022

It is more tricky than I thought. Actually I see the error "sometimes" on fresh builds only. That's not clear yet ...

@ferdymercury
Copy link
Contributor Author

Maybe it's just a multi-threading thing? The output lines are ordered differently each time because the threads write to stdout in different order. If you Search for "latex5.C", don't you see always a warning line (every time in different position):
/home/sftnight/build/workspace/root-makedoc-master/rootspi/rdoc/src/master/tutorials/graphics/latex5.C:8: warning: image file pict1_latex5.C.png is not found in IMAGE_PATH: assuming external image.

@couet
Copy link
Member

couet commented Nov 7, 2022

I thought of it, that's why I do not use the option -j to be sure it is not multithreaded. I will investigate further asap.

@phsft-bot
Copy link
Collaborator

Starting build on ROOT-debian10-i386/soversion, ROOT-performance-centos8-multicore/cxx17, ROOT-ubuntu18.04/nortcxxmod, ROOT-ubuntu2004/python3, mac12/noimt, mac11/cxx14, windows10/cxx14
How to customize builds

@couet
Copy link
Member

couet commented Jul 10, 2023

Do we still want this? It does not seem really safe...

@ferdymercury ferdymercury marked this pull request as draft April 8, 2024 08:28
@ferdymercury ferdymercury deleted the imagewarnings branch May 2, 2024 07:40
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