Bug 49338 - [next] make documentation work
Summary: [next] make documentation work
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: http://cgit.freedesktop.org/~smcv/tel...
Whiteboard:
Keywords:
Depends on:
Blocks: tp-glib-1.0
  Show dependency treegraph
 
Reported: 2012-05-01 06:39 UTC by Simon McVittie
Modified: 2012-05-04 07:32 UTC (History)
2 users (show)

See Also:
i915 platform:
i915 features:


Attachments
01/15] _tp_dbus_starter_bus_conn: remove (2.05 KB, patch)
2012-05-01 06:41 UTC, Simon McVittie
Details | Splinter Review
[02/15] Move TpDebugClient generated code to cli-misc.[ch] and don't document it (3.43 KB, patch)
2012-05-01 06:42 UTC, Simon McVittie
Details | Splinter Review
03/15] Add missing </SECTION> so cli-account-manager docs get generated (882 bytes, patch)
2012-05-01 06:43 UTC, Simon McVittie
Details | Splinter Review
04/15] Hide split reentrant methods in documentation (935 bytes, patch)
2012-05-01 06:45 UTC, Simon McVittie
Details | Splinter Review
05/15] Hide tp_cli_add_signals functions from documentation (4.28 KB, patch)
2012-05-01 06:45 UTC, Simon McVittie
Details | Splinter Review
06/15] tp_base_client_get_account_manager: remove from docs, no longer exists (833 bytes, patch)
2012-05-01 06:45 UTC, Simon McVittie
Details | Splinter Review
07/15] TpBaseChannelClass: fully remove interfaces member (741 bytes, patch)
2012-05-01 06:45 UTC, Simon McVittie
Details | Splinter Review
08/15] TpBaseConnectionCreateChannelFactoriesImpl: fully remove (1.50 KB, patch)
2012-05-01 06:46 UTC, Simon McVittie
Details | Splinter Review
09/15] tp_presence_mixin_register_with_contacts_mixin: fix documentation (867 bytes, patch)
2012-05-01 06:46 UTC, Simon McVittie
Details | Splinter Review
10/15] Remove NUM_TP_* from generated code (1.21 KB, patch)
2012-05-01 06:46 UTC, Simon McVittie
Details | Splinter Review
11/15] Add `make clean-for-new-branch` (1.03 KB, patch)
2012-05-01 06:47 UTC, Simon McVittie
Details | Splinter Review
12/15] Update documentation structure for TpContact features (1.27 KB, patch)
2012-05-01 06:48 UTC, Simon McVittie
Details | Splinter Review
13/15] Resync sections.txt with this version of telepathy-spec (7.73 KB, patch)
2012-05-01 06:48 UTC, Simon McVittie
Details | Splinter Review
14/15] Mark private headers as such in the header (15.86 KB, patch)
2012-05-01 06:48 UTC, Simon McVittie
Details | Splinter Review
15/15] Provide introductory doc-comments for all the new cli-* sections (3.61 KB, patch)
2012-05-01 06:49 UTC, Simon McVittie
Details | Splinter Review

Description Simon McVittie 2012-05-01 06:39:23 UTC
+++ This bug was initially created as a clone of Bug #31668 +++

The documentation check on next currently fails. Let's get it into shape again.
Comment 1 Simon McVittie 2012-05-01 06:41:03 UTC
Created attachment 60836 [details] [review]
01/15] _tp_dbus_starter_bus_conn: remove

There's no longer any need to cache a singleton starter bus connection,
because the only caller also caches a singleton.

---

Not really directly relevant, but it's been sitting on a trivia branch for a while.
Comment 2 Simon McVittie 2012-05-01 06:42:29 UTC
Created attachment 60837 [details] [review]
[02/15] Move TpDebugClient generated code to cli-misc.[ch] and  don't document it

---

This is the end of Bug #46835, but probably also needed for this one
Comment 3 Simon McVittie 2012-05-01 06:43:58 UTC
Created attachment 60840 [details] [review]
03/15] Add missing </SECTION> so cli-account-manager docs get  generated
Comment 4 Simon McVittie 2012-05-01 06:45:03 UTC
Created attachment 60841 [details] [review]
04/15] Hide split reentrant methods in documentation
Comment 5 Simon McVittie 2012-05-01 06:45:20 UTC
Created attachment 60842 [details] [review]
05/15] Hide tp_cli_add_signals functions from documentation
Comment 6 Simon McVittie 2012-05-01 06:45:35 UTC
Created attachment 60843 [details] [review]
06/15] tp_base_client_get_account_manager: remove from docs,  no longer exists
Comment 7 Simon McVittie 2012-05-01 06:45:48 UTC
Created attachment 60844 [details] [review]
07/15] TpBaseChannelClass: fully remove interfaces member
Comment 8 Simon McVittie 2012-05-01 06:46:02 UTC
Created attachment 60845 [details] [review]
08/15] TpBaseConnectionCreateChannelFactoriesImpl: fully  remove
Comment 9 Simon McVittie 2012-05-01 06:46:18 UTC
Created attachment 60846 [details] [review]
09/15] tp_presence_mixin_register_with_contacts_mixin: fix  documentation
Comment 10 Simon McVittie 2012-05-01 06:46:39 UTC
Created attachment 60847 [details] [review]
10/15] Remove NUM_TP_* from generated code

---

I thought I'd done this already :-(
Comment 11 Simon McVittie 2012-05-01 06:47:52 UTC
Created attachment 60848 [details] [review]
11/15] Add `make clean-for-new-branch`

---

I think this is appropriate to call when switching branch and keeping the same builddir. distclean is too much (you lose your configure options), but clean isn't enough.

This should ideally go into master and even 0.18 too.
Comment 12 Simon McVittie 2012-05-01 06:48:08 UTC
Created attachment 60849 [details] [review]
12/15] Update documentation structure for TpContact features
Comment 13 Simon McVittie 2012-05-01 06:48:23 UTC
Created attachment 60850 [details] [review]
13/15] Resync sections.txt with this version of  telepathy-spec
Comment 14 Simon McVittie 2012-05-01 06:48:58 UTC
Created attachment 60851 [details] [review]
14/15] Mark private headers as such in the header

This means we don't have to remember to list them all in
docs/reference/Makefile.am, which seems like a win.
 
We still need to list proxy-introspectable.h, which is a bit of a
special case.

---

I'll apply a similar change to master at some point.
Comment 15 Simon McVittie 2012-05-01 06:49:15 UTC
Created attachment 60852 [details] [review]
15/15] Provide introductory doc-comments for all the new  cli-* sections
Comment 16 Jonny Lamb 2012-05-01 09:00:13 UTC
Comment on attachment 60849 [details] [review]
12/15] Update documentation structure for TpContact features

Review of attachment 60849 [details] [review]:
-----------------------------------------------------------------

::: docs/reference/telepathy-glib-sections.txt
@@ +3819,5 @@
> +tp_contact_get_feature_quark_contact_groups
> +tp_contact_get_feature_quark_contact_info
> +tp_contact_get_feature_quark_location
> +tp_contact_get_feature_quark_presence
> +tp_contact_get_feature_quark_subscription_states

Huh did I not do this? Sorry about that.
Comment 17 Jonny Lamb 2012-05-01 09:05:11 UTC
Well I was scared of there being fifteen patches to review but it was trivial enough. Gogogogogo.
Comment 18 Simon McVittie 2012-05-02 04:26:13 UTC
(In reply to comment #11)
> 11/15] Add `make clean-for-new-branch`
...
> This should ideally go into master and even 0.18 too.

I merged this one via 0.18 and master, and the rest straight into next.

(In reply to comment #14)
> 14/15] Mark private headers as such in the header
...
> I'll apply a similar change to master at some point.

I'd still like to do this, so I'll leave this bug open for now.
Comment 19 Simon McVittie 2012-05-04 07:32:00 UTC
(In reply to comment #18)
> > 14/15] Mark private headers as such in the header
> ...
> > I'll apply a similar change to master at some point.

Now part of Bug #49384, so I'll close this one.


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.