After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 749577 - Allow multiple namespaces
Allow multiple namespaces
Status: RESOLVED OBSOLETE
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal enhancement
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2015-05-19 12:05 UTC by Emmanuele Bassi (:ebassi)
Modified: 2018-05-22 13:10 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Emmanuele Bassi (:ebassi) 2015-05-19 12:05:16 UTC 
The --name-space argument to gtkdoc-mkdb should allow specifying multiple namespaces, for libraries that have them in the same shared object.

For instance: Cally is a sub-API inside the Clutter shared library.

A simple solution would be to accept multiple `--name-space` arguments and make the $NAME_SPACE variable an array; then, iterate over every element of the array when doing matching.
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2015-05-19 18:59:55 UTC 
Can't you build two separate documentation books - one for each library?
Comment 2 Emmanuele Bassi (:ebassi) 2016-04-10 18:01:24 UTC 
No, the whole idea is to have all the documentation in one place, to minimize cross-linking.
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2016-04-30 09:30:37 UTC 
I had a quick look at the code, it would need a bit more work on the index. Should the be one unified index or one index per namespace? The whole file-naming scheme as used now does not support different indexes. If it is a unified index, it could be confusing, since we drop the namespace (so that gtk_window_new is under 'w' and not'g').
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2018-05-21 15:43:44 UTC 
Ping?
Comment 5 Emmanuele Bassi (:ebassi) 2018-05-21 15:53:02 UTC 
I haven't really thought about the multiple index, and indeed it's a problem.

One symbol index per namespace would probably be enough, but I'm afraid of the explosion of per-version indices.

Maybe this whole idea is a bit meh and I should split off the Cally API reference back again…
Comment 6 GNOME Infrastructure Team 2018-05-22 13:10:05 UTC 
-- GitLab Migration Automatic Message --

This bug has been migrated to GNOME's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/gtk-doc/issues/32.