gazebosim / gz-cmake

A set of CMake modules that are used by the C++-based Gazebo projects.
https://gazebosim.org/libs/cmake
Apache License 2.0
22 stars 28 forks source link

Doxygen tags install directory #37

Open osrf-migration opened 6 years ago

osrf-migration commented 6 years ago

Original report (archived issue) by Louise Poubel (Bitbucket: chapulina, GitHub: chapulina).


I just noticed that the doxygen tags are ending up in directories with duplicate ignition such as:

/usr/local/share/ignition/ignition-common1_1/ignition-common1.tag.xml

Should that be going to the following instead?

/usr/local/share/ignition/common1/ignition-common1.tag.xml

osrf-migration commented 6 years ago

Original comment by Michael Grey (Bitbucket: mxgrey, GitHub: mxgrey).


I think this depends on whether we want to support separate tag files for multiple minor versions (assuming the 1_1 is referring to version 1.1).

We only support installing one minor version of a development package at a time per major version, so maybe it doesn't make sense to allow the tag files of multiple minor versions of an API to be installed.

osrf-migration commented 6 years ago

Original comment by Louise Poubel (Bitbucket: chapulina, GitHub: chapulina).


I think that even if we want to keep the 1_1, it should be in the file rather than the directory. And the directory should lose the ignition- prefix, which seems to be differing from the pattern used for other files.

For example, fuel-tools is installing its config file at:

/usr/local/share/ignition/fuel_tools1/config.yaml

Rendering is installing media files at:

/usr/local/share/ignition/rendering-0/ogre/media/...

(also note that fuel-tools and rendering have different styles, we should settle on either no dash or yes dash)

osrf-migration commented 6 years ago

Original comment by Michael Grey (Bitbucket: mxgrey, GitHub: mxgrey).


The ignition- prefix certainly does seem redundant.

I would strongly recommend we use no-dash (e.g. rendering0 instead of rendering-0) to be consistent with the library naming scheme.

osrf-migration commented 6 years ago

Original comment by Steve Peters (Bitbucket: Steven Peters, GitHub: scpeters).


I think we just need to change IGN_DATA_INSTALL_DIR_POSTFIX