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

Fix version variable in reference manual PDF filename #1363

Merged
merged 1 commit into from
Jan 30, 2024

Conversation

cottsay
Copy link
Contributor

@cottsay cottsay commented Jan 30, 2024

🦟 Bug fix

Summary

The variable SDF_VERSION_FULL is a C preprocessor macro which is set to the value of the CMake variable PROJECT_VERSION_FULL in config.hh.in. It is not defined as a CMake variable itself, and currently evaluates to an empty string resulting in refman.pdf being renamed to sdf-.pdf.

#define SDF_VERSION_FULL "${PROJECT_VERSION_FULL}"

$ grep SDF_VERSION_FULL . -R
./src/gz.cc:  return _strdup(SDF_VERSION_FULL);
./src/gz.cc:  return strdup(SDF_VERSION_FULL);
./src/gz_TEST.cc:  return " --force-version " + std::string(SDF_VERSION_FULL);
./doc/CMakeLists.txt:    ${CMAKE_BINARY_DIR}/doxygen/latex/sdf-${SDF_VERSION_FULL}.pdf
./include/sdf/config.hh.in:#define SDF_VERSION_FULL "${PROJECT_VERSION_FULL}"

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

The variable SDF_VERSION_FULL is a C preprocessor macro which is set to
the value of the CMake variable PROJECT_VERSION_FULL in config.hh.in. It
is not defined as a CMake variable itself, and currently evaluates to an
empty string resulting in refman.pdf being renamed to sdf-.pdf.

Signed-off-by: Scott K Logan <logans@cottsay.net>
@github-actions github-actions bot added the 🎵 harmonic Gazebo Harmonic label Jan 30, 2024
Copy link
Collaborator

@azeey azeey left a comment

Choose a reason for hiding this comment

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

We don't actually use the generated pdfs for anything AFAIK. I'll create an issue to remove them.

EDIT: #1364

Copy link

codecov bot commented Jan 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c3960a5) 92.40% compared to head (eb997e7) 92.40%.
Report is 2 commits behind head on sdf14.

Additional details and impacted files
@@           Coverage Diff           @@
##            sdf14    #1363   +/-   ##
=======================================
  Coverage   92.40%   92.40%           
=======================================
  Files         134      134           
  Lines       17674    17674           
=======================================
  Hits        16332    16332           
  Misses       1342     1342           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@azeey azeey merged commit d40b96f into gazebosim:sdf14 Jan 30, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎵 harmonic Gazebo Harmonic
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants