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

Fixup DISTCONFDIR and MODULE_DIRECTORY references in the docs #99

Open
evelikov opened this issue Sep 3, 2024 · 6 comments
Open

Fixup DISTCONFDIR and MODULE_DIRECTORY references in the docs #99

evelikov opened this issue Sep 3, 2024 · 6 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@evelikov
Copy link
Collaborator

evelikov commented Sep 3, 2024

With the introduction of the two build toggles, they feature as hard-coded in the docs.

Off the top of my head, there's no obvious way to fix it without some additional pre-post processing. Perhaps (at least for DISTCONFDIR) we can reference the relevant man page, which does much better job and explaining the topic.

@hramrach would you be interested in sorting this out? I can happily offer some virtual 🍪 in exchange :-P

@evelikov evelikov added bug Something isn't working documentation Improvements or additions to documentation labels Sep 3, 2024
@hramrach
Copy link
Contributor

hramrach commented Sep 4, 2024

Where are the directories hardcoded?

I tried to fix the man pages when adding the options but the man page build was overhauled since then.

@evelikov
Copy link
Collaborator Author

evelikov commented Sep 4, 2024

The man pages were broken, in some corner cases, and should be fixed with 52a9d42.

I'm taking about the gtk-doc here. This gets processed by gtk-doc (build with ./configure --enable-gtk-doc) which produces libkmod-libkmod.html with the ALL_CAPS instances, instead of the actual values.

Mind you, it's not urgent nor that important. Just I thought about creating an issue, before I forget about it again.

@hramrach
Copy link
Contributor

hramrach commented Sep 6, 2024

And I suppose using a temporary file would be bad because gtkdoc embeds the filename, and replacing after the fact in the generated document might work for HTML but not if other output formats are added.

@evelikov
Copy link
Collaborator Author

There are two simpler(?) solutions off the top of my head:

  • git mv libkmod.h{.in,}, and meson substitude the @FOO@ variables creating libkmod.h a as prep step before the build/gtkdoc
  • inject fixup state between gtkdoc generation and install ... not 100% sure if it's possible. as alternative fixup and do installation manually?

Of the above, my inclination is for the former although if you have another quick and simple solution that'll be fine.

@lucasdemarchi
Copy link
Contributor

I'd rather leave them as constants and reference somewhere they are defined at build time and may vary among distros. If/when we follow the plan of adding the website with the docs, it'd be strange to substitute it since it won't universally match

@evelikov
Copy link
Collaborator Author

evelikov commented Sep 14, 2024

Good point.

Fwiw we should probably drop the leading $ in $MODULE_DIRECTORY or alternatively add one for DISTCONFDIR. Atm they are rather inconsistent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants