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

[Next] Fix docs meson option #662

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

timp87
Copy link

@timp87 timp87 commented Dec 20, 2024

There are multiple issues if you try to build xreader with docs option set

help/reference/libview/meson.build:13:18: ERROR: Unknown variable "libdoc_deps"

help/reference/libview/meson.build:16:6: ERROR: gnome.gtkdoc got unknown keyword arguments "cflags"

help/reference/shell/meson.build:16:6: ERROR: gnome.gtkdoc got unknown keyword arguments "cflags"

Fix error like:

help/reference/libview/meson.build:13:18: ERROR: Unknown variable "libdoc_deps"
Fix error:

help/reference/libview/meson.build:16:6: ERROR: gnome.gtkdoc got unknown keyword arguments "cflags"
It fixes error

help/reference/shell/meson.build:16:6: ERROR: gnome.gtkdoc got unknown keyword arguments "cflags"
@timp87
Copy link
Author

timp87 commented Dec 20, 2024

Faced also with this one #549
Looking at it

@clefebvre clefebvre changed the title Fix docs meson option [Next] Fix docs meson option Jan 6, 2025
Static libs are ignored for gtkdoc.
The trick here is to build both static and dynamic, use static in the same place as before and use dynamic for doc.
Also remove uneeded parts of declare_dependency in help/reference/shell/meson.build and add proper src_dir later.
@timp87
Copy link
Author

timp87 commented Jan 26, 2025

I looked into the code (mesonbuild/modules/gnome.py) it seems like there is no way to pass a static lib (libshell) into gnome.gtkdoc. The fix is to compile both and pass each lib type where needed.

@timp87
Copy link
Author

timp87 commented Jan 26, 2025

@clefebvre can you take a look please?
I have added a few more commits here. And it's not clear if I do c2a0583 correctly.

@timp87 timp87 force-pushed the fix-docs-meson-option branch from c97d2a4 to ac5e12a Compare January 26, 2025 20:59
I'm not sure I'm doing here everything right, so it's just my assumption:

The header I migrate from libview_private_headers to libview_headers are used in the documentation.
Also they do not have this inside:

#if !defined (XREADER_COMPILATION)
#error "This is a private header."
#endif

like other private header do (libview/ev-link-accessible.h) for example.

So if I'm wrong and the headers I move are really private then:
- they should have this "error "This is a private header." listed above as well
- they should be removed from xml to generate doc for shell
@timp87 timp87 force-pushed the fix-docs-meson-option branch from ac5e12a to c2a0583 Compare January 26, 2025 21:02
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.

1 participant