| Summary: | [next] improve documentation/header layout | ||
|---|---|---|---|
| Product: | Telepathy | Reporter: | Simon McVittie <smcv> |
| Component: | tp-glib | Assignee: | Simon McVittie <smcv> |
| Status: | RESOLVED FIXED | QA Contact: | Telepathy bugs list <telepathy-bugs> |
| Severity: | normal | ||
| Priority: | medium | Keywords: | patch |
| Version: | git master | ||
| Hardware: | Other | ||
| OS: | All | ||
| Whiteboard: | |||
| i915 platform: | i915 features: | ||
| Attachments: |
1/4] Install interfaces.h as part of the -dbus library
2/4] Move documentation of low-level (D-Bus-API-dependent) things to the end 3/4] Move Telepathy constants like TP_CM_BUS_NAME_BASE to interfaces.[ch] 4/4] Move user action time constants to enums.h [5] Move -dbus library headers into a new telepathy-glib-dbus.h meta-header |
||
|
Description
Simon McVittie
2012-05-02 04:29:32 UTC
Created attachment 60891 [details] [review] 1/4] Install interfaces.h as part of the -dbus library --- The corresponding .c file is in the -dbus library, and the interface names are D-Bus-API-specific, so to include the header you should be forced to use the -dbus pkg-config module. Created attachment 60892 [details] [review] 2/4] Move documentation of low-level (D-Bus-API-dependent) things to the end Created attachment 60893 [details] [review] 3/4] Move Telepathy constants like TP_CM_BUS_NAME_BASE to interfaces.[ch] These will break API when the other D-Bus API things do, so they should go together. Created attachment 60894 [details] [review] 4/4] Move user action time constants to enums.h They're numeric, so, close enough... Yeah, looks fine. Created attachment 60895 [details] [review] [5] Move -dbus library headers into a new telepathy-glib-dbus.h meta-header --- I realised while looking at those attachments that as long as telepathy-glib.h includes interfaces.h, the library split is rather meaningless, because you can't #include <telepathy-glib.h> without error unless you use the -dbus pkg-config module. So, let's fix that. As you can see from the header file changes in examples/tests/misc, this will break everyone, but I think it's a necessary evil. Comment on attachment 60895 [details] [review] [5] Move -dbus library headers into a new telepathy-glib-dbus.h meta-header Review of attachment 60895 [details] [review]: ----------------------------------------------------------------- Yeah this looks fine. lolz that we both forgot about it though. In git. |
Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.