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

Meson is missing the creation of doxygen.conf #182

Closed
Jakuje opened this issue May 6, 2024 · 5 comments
Closed

Meson is missing the creation of doxygen.conf #182

Jakuje opened this issue May 6, 2024 · 5 comments

Comments

@Jakuje
Copy link
Contributor

Jakuje commented May 6, 2024

When building the latest version 2.2.0 with meson, I do not get doxygen.conf generated from doxygen.conf.in causing Fedora build to fail as we use that one to gerenate doc supbackage.

It should be just matter of passing it to configure_file (maybe under the conditional for generating separate docs?). Something like this works already:

diff --git a/meson.build b/meson.build
index ab23b161..373e32a3 100644
--- a/meson.build
+++ b/meson.build
@@ -251,6 +251,9 @@ configure_file(output : 'pcscd.8',
   input : 'doc/pcscd.8.in',
   install_dir : join_paths(get_option('mandir'), 'man8'),
   configuration : confgen_data)
+configure_file(output : 'doxygen.conf',
+  input : 'doc/doxygen.conf.in',
+  configuration : confgen_data)
 if get_option('serial')
 configure_file(output : 'reader.conf.5',
   input : 'doc/reader.conf.5.in',

Its question if it makes sense to keep it like this or we want to allow building the docs in some more standard way than calling doxygen from spec file directly.

@LudovicRousseau
Copy link
Owner

Exact.

Generating the doxygen.conf file will not be enough.
I generate the documentation using make doxygen and this will not work with meson.

What "more standard way" are you thinking about?

@Jakuje
Copy link
Contributor Author

Jakuje commented May 7, 2024

This would be enough for the way how we do it in Fedora package now as we run doxygen directly during build:

https://src.fedoraproject.org/rpms/pcsc-lite/blob/rawhide/f/pcsc-lite.spec#_104

By standard way I meant checking the doxygen presence in meson and creating the API docs as part of meson build, by default or with specific target.

@LudovicRousseau
Copy link
Owner

Done in a217c5c

Do you think meson should also install the documentation?
If yes where?

@Jakuje
Copy link
Contributor Author

Jakuje commented May 7, 2024

Thanks! The change looks good to me.

Regarding to the installation, the fedora package pushes them into /usr/share/doc/pcsc-lite-doc/api, which is basically what the build system passes to meson as --datadir + /doc/ + package name, so I would consider this distribution dependent and not install it (Fedora macro %doc copies the files from build root to the proper location).

https://koji.fedoraproject.org/koji/rpminfo?rpmID=37946302

@LudovicRousseau
Copy link
Owner

I did not know the pcsc-lite-doc fedora package.

On my side. I generate the documentation to populate the web site https://pcsclite.apdu.fr/api/

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

No branches or pull requests

2 participants