Bug 35182

Summary: misc small documentation fixes
Product: dbus Reporter: Simon McVittie <smcv>
Component: coreAssignee: Simon McVittie <smcv>
Status: RESOLVED FIXED QA Contact: Rob Taylor <rob.taylor>
Severity: minor    
Priority: low CC: will
Version: 1.4.xKeywords: patch
Hardware: Other   
OS: All   
URL: http://git.collabora.co.uk/?p=user/smcv/dbus-smcv.git;a=shortlog;h=refs/heads/doc-trivia
Whiteboard: review-
i915 platform: i915 features:
Attachments: [PATCH 1/4] dbus_message_iter_append_basic: remove misleading documentation
[PATCH 2/4] _dbus_marshal_write_fixed_multi: remove obsolete FIXME comment
[PATCH 3/4] dbus_connection_can_send_type: clarify that invalid codes are allowed here
[PATCH 4/4] add doxygen.stamp to .gitignore

Description Simon McVittie 2011-03-10 10:56:53 UTC
Created attachment 44318 [details] [review]
[PATCH 1/4] dbus_message_iter_append_basic: remove misleading documentation

See branch/patches.

---

Extended commit message for 1/4:

This function specifically doesn't support Unix fds and is documented as
such.
Comment 1 Simon McVittie 2011-03-10 10:57:13 UTC
Created attachment 44319 [details] [review]
[PATCH 2/4] _dbus_marshal_write_fixed_multi: remove obsolete FIXME comment

As far as I can tell, we've never accepted out-of-range booleans and
canonicalized them, ever since this was first committed in 2004. If sent,
they'd be considered to be invalid by recipients, so they're unambiguously
an error.
Comment 2 Simon McVittie 2011-03-10 10:57:27 UTC
Created attachment 44320 [details] [review]
[PATCH 3/4] dbus_connection_can_send_type: clarify that invalid codes are allowed here

This is sufficiently unusual that it seems worth saying explicitly
Comment 3 Simon McVittie 2011-03-10 10:57:43 UTC
Created attachment 44321 [details] [review]
[PATCH 4/4] add doxygen.stamp to .gitignore
Comment 4 Will Thompson 2011-03-10 11:00:09 UTC
Review of attachment 44320 [details] [review]:

::: dbus/dbus-connection.c
@@ +3084,3 @@
  * might be unknown to the specific D-Bus client implementation
  * version, i.e. it will return FALSE for all types this
+ * implementation does not know, including invalid or reserved types.

Give an example of a reserved type, maybe? I think I know what you mean, but I'm unusually keen on type systems.
Comment 5 Will Thompson 2011-03-10 11:00:29 UTC
The other three patches look fine.
Comment 6 Simon McVittie 2011-03-10 11:18:16 UTC
Comment on attachment 44318 [details] [review]
[PATCH 1/4] dbus_message_iter_append_basic: remove misleading documentation

in git for 1.4.8
Comment 7 Simon McVittie 2011-03-10 11:18:31 UTC
Comment on attachment 44319 [details] [review]
[PATCH 2/4] _dbus_marshal_write_fixed_multi: remove obsolete FIXME comment

in git for 1.4.8
Comment 8 Simon McVittie 2011-03-10 11:18:34 UTC
Comment on attachment 44321 [details] [review]
[PATCH 4/4] add doxygen.stamp to .gitignore

in git for 1.4.8
Comment 9 Simon McVittie 2011-03-10 11:19:15 UTC
(In reply to comment #4)
> Give an example of a reserved type, maybe? I think I know what you mean, but
> I'm unusually keen on type systems.

19:08 < smcv> wjt: re 
              https://bugs.freedesktop.org/review?bug=35182&attachment=44320 I 
              actually mean the typecodes that *should be* reserved, like '*' 
              (https://bugs.freedesktop.org/show_bug.cgi?id=34529)
Comment 10 Will Thompson 2011-05-02 06:04:41 UTC
(In reply to comment #9)
> (In reply to comment #4)
> > Give an example of a reserved type, maybe? I think I know what you mean, but
> > I'm unusually keen on type systems.
> 
> 19:08 < smcv> wjt: re 
>               https://bugs.freedesktop.org/review?bug=35182&attachment=44320 I 
>               actually mean the typecodes that *should be* reserved, like '*' 
>               (https://bugs.freedesktop.org/show_bug.cgi?id=34529)

Okay, ship the patch as-is.
Comment 11 Simon McVittie 2011-05-03 02:28:47 UTC
Thanks, merged for 1.4.10/1.5.2.

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.