-
Notifications
You must be signed in to change notification settings - Fork 41
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
Comments
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. |
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 Mind you, it's not urgent nor that important. Just I thought about creating an issue, before I forget about it again. |
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. |
There are two simpler(?) solutions off the top of my head:
Of the above, my inclination is for the former although if you have another quick and simple solution that'll be fine. |
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 |
Good point. Fwiw we should probably drop the leading |
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
The text was updated successfully, but these errors were encountered: