Bug 49377 - [next] improve documentation/header layout
Summary: [next] improve documentation/header layout
Status: RESOLVED FIXED
Alias: None
Product: Telepathy
Classification: Unclassified
Component: tp-glib (show other bugs)
Version: git master
Hardware: Other All
: medium normal
Assignee: Simon McVittie
QA Contact: Telepathy bugs list
URL:
Whiteboard:
Keywords: patch
Depends on:
Blocks:
 
Reported: 2012-05-02 04:29 UTC by Simon McVittie
Modified: 2012-05-03 10:43 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Attachments
1/4] Install interfaces.h as part of the -dbus library (867 bytes, patch)
2012-05-02 04:31 UTC, Simon McVittie
Details | Splinter Review
2/4] Move documentation of low-level (D-Bus-API-dependent) things to the end (9.46 KB, patch)
2012-05-02 04:31 UTC, Simon McVittie
Details | Splinter Review
3/4] Move Telepathy constants like TP_CM_BUS_NAME_BASE to interfaces.[ch] (11.56 KB, patch)
2012-05-02 04:32 UTC, Simon McVittie
Details | Splinter Review
4/4] Move user action time constants to enums.h (7.05 KB, patch)
2012-05-02 04:32 UTC, Simon McVittie
Details | Splinter Review
[5] Move -dbus library headers into a new telepathy-glib-dbus.h meta-header (29.12 KB, patch)
2012-05-02 05:27 UTC, Simon McVittie
Details | Splinter Review

Description Simon McVittie 2012-05-02 04:29:32 UTC
Some follow-ups for Bug #49338.
Comment 1 Simon McVittie 2012-05-02 04:31:29 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.
Comment 2 Simon McVittie 2012-05-02 04:31:45 UTC
Created attachment 60892 [details] [review]
2/4] Move documentation of low-level (D-Bus-API-dependent)  things to the end
Comment 3 Simon McVittie 2012-05-02 04:32:00 UTC
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.
Comment 4 Simon McVittie 2012-05-02 04:32:17 UTC
Created attachment 60894 [details] [review]
4/4] Move user action time constants to enums.h

They're numeric, so, close enough...
Comment 5 Jonny Lamb 2012-05-02 04:43:51 UTC
Yeah, looks fine.
Comment 6 Simon McVittie 2012-05-02 05:27:18 UTC
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 7 Jonny Lamb 2012-05-02 06:31:21 UTC
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.
Comment 8 Simon McVittie 2012-05-03 10:43:17 UTC
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.