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

Use dirsync for doxygen directory syncing #13639

Closed
carlescufi opened this issue Feb 21, 2019 · 3 comments
Closed

Use dirsync for doxygen directory syncing #13639

carlescufi opened this issue Feb 21, 2019 · 3 comments
Assignees
Labels
area: Documentation Enhancement Changes/Updates/Additions to existing features

Comments

@carlescufi
Copy link
Member

This commit introduced a mechanism to preserve mtime in Doxygen-generated XML files in order to avoid having to process unchanged files every time we incrementally build the doc. More info can be found in this thread.

The dirsync library seems up to the task, so potentially it could be used to replace much of the code in the script.

@carlescufi carlescufi added Enhancement Changes/Updates/Additions to existing features area: Documentation labels Feb 21, 2019
@marc-hb
Copy link
Collaborator

marc-hb commented Feb 21, 2019

Thanks @carlescufi for filing this. I'm the one to blame for the additional 100 lines of restore_modification_times.py and I agree it would be nice to get rid of most of them and replace them by a rsync-like python library as very well explained in the doxygen mailing-list thread above.
Summarizing a private discussion with @carlescufi : the most critical requirement is obviously the ability NOT to copy/update the modification timestamp when it is newer but the content has not changed. This is more or less the --checksum option of rsync.
Also important is the equivalent of rsync's --delete option to remove renamed or deleted XML files.

As usual, the library replacement needs to be evaluated with respect to quality, maintainer responsiveness etc.

@marc-hb
Copy link
Collaborator

marc-hb commented Apr 7, 2021

This commit introduced...

Ouch, I spent ages last week looking for this old issue and gave up eventually. Mentioning a commit links only one way. Mentioning PR #13159 here links both ways and would have let me find this issue :-)

@gmarull
Copy link
Member

gmarull commented Aug 11, 2022

doxyrunner replaced the mechanism described here, closing.

@gmarull gmarull closed this as completed Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation Enhancement Changes/Updates/Additions to existing features
Projects
None yet
Development

No branches or pull requests

3 participants