Bug#525546: libxi-dev: manpage bugs in XInput.h related manpages

To: 525546@bugs.debian.org
Subject: Bug#525546: libxi-dev: manpage bugs in XInput.h related manpages
From: "Bernhard R. Link" <brlink@debian.org>
Date: Tue, 28 Apr 2009 18:41:56 +0200
Message-id: <[🔎] 20090428164155.GA837@pcpool00.mathematik.uni-freiburg.de>
Reply-to: "Bernhard R. Link" <brlink@debian.org>, 525546@bugs.debian.org
In-reply-to: <[🔎] 20090428143859.GZ17079@patate.is-a-geek.org>
References: <[🔎] 20090425111820.GA17865@pcpool00.mathematik.uni-freiburg.de> <[🔎] 20090428143859.GZ17079@patate.is-a-geek.org>

* Julien Cristau <jcristau@debian.org> [090428 16:43]:
> > XInput related manpages have same inaccuraties in their SYNTAX lines:

> any chance you could look whether these still apply to
> http://cgit.freedesktop.org/xorg/lib/libXi/tree/man/XI.xml

seems to still have the same issues.

> and send patches for that file?

attached patch might fix it. Totally untested and done without
understanding of the format of that file.

Hochachtungsvoll,
	Bernhard R. Link

--- XI.xml	2009-04-28 18:30:23.000000000 +0200
+++ XI.xml.patched	2009-04-28 18:39:26.000000000 +0200
@@ -256,7 +256,7 @@
                 <funcdef>int <function>XChangeDeviceDontPropagateList</function></funcdef>
                 <paramdef>Display *<parameter>display</parameter></paramdef>
                 <paramdef>Window*<parameter>window</parameter></paramdef>
-                <paramdef>int *<parameter>count</parameter></paramdef>
+                <paramdef>int <parameter>count</parameter></paramdef>
                 <paramdef>XEventClass *<parameter>event_list</parameter></paramdef>
                 <paramdef>int<parameter>mode</parameter></paramdef>
             </funcprototype>
@@ -637,9 +637,9 @@
                 <funcdef>Status <function>XDeviceBell</function></funcdef>
                 <paramdef>Display *<parameter>display</parameter></paramdef>
                 <paramdef>XDevice *<parameter>device</parameter></paramdef>
-                <paramdef>XID *<parameter>feedbackclass</parameter></paramdef>
-                <paramdef>XID *<parameter>feedbackid</parameter></paramdef>
-                <paramdef>int *<parameter>percent</parameter></paramdef>
+                <paramdef>XID <parameter>feedbackclass</parameter></paramdef>
+                <paramdef>XID <parameter>feedbackid</parameter></paramdef>
+                <paramdef>int <parameter>percent</parameter></paramdef>
             </funcprototype>
         </funcsynopsis>
     </refsynopsisdiv>
@@ -759,7 +759,7 @@
                 <funcdef>XDeviceControl *<function>XGetDeviceControl</function></funcdef>
                 <paramdef>Display *<parameter>display</parameter></paramdef>
                 <paramdef>XDevice*<parameter>device</parameter></paramdef>
-                <paramdef>int *<parameter>controlType</parameter></paramdef>
+                <paramdef>int <parameter>controlType</parameter></paramdef>
             </funcprototype>
             <funcprototype>
                 <funcdef>int <function>XChangeDeviceControl</function></funcdef>
@@ -3326,7 +3326,7 @@
         <funcsynopsis>
             <funcsynopsisinfo>#include &lt;X11/extensions/XInput.h&gt;</funcsynopsisinfo>
             <funcprototype>
-                <funcdef>int <function>XQueryDeviceState</function></funcdef>
+                <funcdef>XDeviceState *<function>XQueryDeviceState</function></funcdef>
                 <paramdef>Display *<parameter>display</parameter></paramdef>
                 <paramdef>XDevice *<parameter>device</parameter></paramdef>
             </funcprototype>
@@ -3460,20 +3460,20 @@
         <funcsynopsis>
             <funcsynopsisinfo>#include &lt;X11/extensions/XInput.h&gt;</funcsynopsisinfo>
             <funcprototype>
-                <funcdef><function>XSelectExtensionEvent</function></funcdef>
+                <funcdef>int <function>XSelectExtensionEvent</function></funcdef>
                 <paramdef>Display *<parameter>display</parameter></paramdef>
                 <paramdef>Window <parameter>w</parameter></paramdef>
                 <paramdef>XEventClass *<parameter>event_list</parameter></paramdef>
                 <paramdef>int <parameter>event_count</parameter></paramdef>
             </funcprototype>
             <funcprototype>
-                <funcdef><function>XGetSelectedExtensionEvents</function></funcdef>
+                <funcdef>int <function>XGetSelectedExtensionEvents</function></funcdef>
                 <paramdef>Display *<parameter>display</parameter></paramdef>
                 <paramdef>Window <parameter>w</parameter></paramdef>
-                <paramdef>int <parameter>this_client_event_count_return</parameter></paramdef>
-                <paramdef>XEventClass *<parameter>this_client_event_list_return</parameter></paramdef>
-                <paramdef>int <parameter>all_clients_event_count_return</parameter></paramdef>
-                <paramdef>XEventClass *<parameter>all_clients_event_list_return</parameter></paramdef>
+                <paramdef>int *<parameter>this_client_event_count_return</parameter></paramdef>
+                <paramdef>XEventClass **<parameter>this_client_event_list_return</parameter></paramdef>
+                <paramdef>int *<parameter>all_clients_event_count_return</parameter></paramdef>
+                <paramdef>XEventClass **<parameter>all_clients_event_list_return</parameter></paramdef>
             </funcprototype>
         </funcsynopsis>
     </refsynopsisdiv>
@@ -4009,7 +4009,7 @@
         <funcsynopsis>
             <funcsynopsisinfo>#include &lt;X11/extensions/XInput.h&gt;</funcsynopsisinfo>
             <funcprototype>
-                <funcdef><function>XSetDeviceFocus</function></funcdef>
+                <funcdef>int <function>XSetDeviceFocus</function></funcdef>
                 <paramdef>Display *<parameter>display</parameter></paramdef>
                 <paramdef>XDevice *<parameter>device</parameter></paramdef>
                 <paramdef>Window <parameter>focus</parameter></paramdef>
@@ -4017,7 +4017,7 @@
                 <paramdef>Time <parameter>time</parameter></paramdef>
             </funcprototype>
             <funcprototype>
-                <funcdef><function>XGetDeviceFocus</function></funcdef>
+                <funcdef>int <function>XGetDeviceFocus</function></funcdef>
                 <paramdef>Display *<parameter>display</parameter></paramdef>
                 <paramdef>XDevice *<parameter>device</parameter></paramdef>
                 <paramdef>Window *<parameter>focus_return</parameter></paramdef>
@@ -4260,7 +4260,7 @@
         <funcsynopsis>
             <funcsynopsisinfo>#include &lt;X11/extensions/XInput.h&gt;</funcsynopsisinfo>
             <funcprototype>
-                <funcdef><function>XSetDeviceMode</function></funcdef>
+                <funcdef>int <function>XSetDeviceMode</function></funcdef>
                 <paramdef>Display *<parameter>display</parameter></paramdef>
                 <paramdef>XDevice *<parameter>device</parameter></paramdef>
                 <paramdef>int  <parameter>mode</parameter></paramdef>
@@ -4365,7 +4365,7 @@
         <funcsynopsis>
             <funcsynopsisinfo>#include &lt;X11/extensions/XInput.h&gt;</funcsynopsisinfo>
             <funcprototype>
-                <funcdef><function>XSetDeviceValuators</function></funcdef>
+                <funcdef>int <function>XSetDeviceValuators</function></funcdef>
                 <paramdef>Display *<parameter>display</parameter></paramdef>
                 <paramdef>XDevice *<parameter>device</parameter></paramdef>
                 <paramdef>int *<parameter>valuators</parameter></paramdef>

Reply to:

References:
- Bug#525546: libxi-dev: manpage bugs in XInput.h related manpages
  - From: "Bernhard R. Link" <brlink@debian.org>
- Bug#525546: libxi-dev: manpage bugs in XInput.h related manpages
  - From: Julien Cristau <jcristau@debian.org>

Prev by Date: Bug#524280: Same problem on Radeon HD 3200
Next by Date: ccsm: Changes to 'debian-unstable'
Previous by thread: Bug#525546: libxi-dev: manpage bugs in XInput.h related manpages
Next by thread: Top 5 Hot Sexy Tips to Spice Up Your Love Life Before It's TToo Late
Index(es):
- Date
- Thread