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 abspath for doxyfile to stop failure #163

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

rkent
Copy link
Contributor

@rkent rkent commented Dec 10, 2024

This simple change use an absolute path rather than a relative path to locate the Doxyfile.

Generally the absolute vs relative path decisions in rosdoc2 are all over the map, and really need a thorough review.

In the current case, a problem occurred on my local build farm, where the locations of files were set using NFS to locations, with soft links to the actual disk storage locations. The error message in Doxygen reported the actual disk location (that is, with the soft link resolved). That caused a mismatch of the '..' count in the relative link. Perhaps somewhere Doxygen is resolving soft links. Really relative paths do not make sense in calls like this to Doxygen, as we are using relative directories on files that could be on completely separate file systems.

I could live without this change as the problem is only occurring locally for me, but I really think the absolute call is the correct way to do this, hence this change in the core code.

@rkent rkent requested review from audrow and tfoote as code owners December 10, 2024 23:47
Copy link
Member

@tfoote tfoote left a comment

Choose a reason for hiding this comment

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

As this isn't a stored value, I think that it should be fine to set the absolute path. I'm assuming that the full path doesn't leak into the output in the same way that a generic relative path wouldn't either.

@tfoote tfoote merged commit f5f26e0 into ros-infrastructure:main Dec 11, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants