protocol: Remove inconsistent line breaks

Enum entries and message arguments are sometimes preceded by a blank line, but
often aren't.

Standardize the format of the protocol specification by removing blank lines
preceding a list of message arguments and enum entries.

Signed-off-by: Yong Bakos <ybakos@humanoriented.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
This commit is contained in:
Yong Bakos 2016-10-31 06:46:18 -07:00 committed by Pekka Paalanen
parent a6cf19842c
commit 66a26aeb2a

View file

@ -226,7 +226,6 @@
so it is valid to destroy the pool immediately after creating so it is valid to destroy the pool immediately after creating
a buffer from it. a buffer from it.
</description> </description>
<arg name="id" type="new_id" interface="wl_buffer" summary="buffer to create"/> <arg name="id" type="new_id" interface="wl_buffer" summary="buffer to create"/>
<arg name="offset" type="int" summary="buffer byte offset within the pool"/> <arg name="offset" type="int" summary="buffer byte offset within the pool"/>
<arg name="width" type="int" summary="buffer width, in pixels"/> <arg name="width" type="int" summary="buffer width, in pixels"/>
@ -252,7 +251,6 @@
created, but using the new size. This request can only be created, but using the new size. This request can only be
used to make the pool bigger. used to make the pool bigger.
</description> </description>
<arg name="size" type="int" summary="new size of the pool, in bytes"/> <arg name="size" type="int" summary="new size of the pool, in bytes"/>
</request> </request>
</interface> </interface>
@ -359,7 +357,6 @@
objects. The server will mmap size bytes of the passed file objects. The server will mmap size bytes of the passed file
descriptor, to use as backing memory for the pool. descriptor, to use as backing memory for the pool.
</description> </description>
<arg name="id" type="new_id" interface="wl_shm_pool" summary="pool to create"/> <arg name="id" type="new_id" interface="wl_shm_pool" summary="pool to create"/>
<arg name="fd" type="fd" summary="file descriptor for the pool"/> <arg name="fd" type="fd" summary="file descriptor for the pool"/>
<arg name="size" type="int" summary="pool size, in bytes"/> <arg name="size" type="int" summary="pool size, in bytes"/>
@ -449,7 +446,6 @@
wl_data_source.cancelled. Clients may still use this event in wl_data_source.cancelled. Clients may still use this event in
conjunction with wl_data_source.action for feedback. conjunction with wl_data_source.action for feedback.
</description> </description>
<arg name="serial" type="uint" summary="serial number of the accept request"/> <arg name="serial" type="uint" summary="serial number of the accept request"/>
<arg name="mime_type" type="string" allow-null="true" summary="mime type accepted by the client"/> <arg name="mime_type" type="string" allow-null="true" summary="mime type accepted by the client"/>
</request> </request>
@ -487,7 +483,6 @@
Sent immediately after creating the wl_data_offer object. One Sent immediately after creating the wl_data_offer object. One
event per offered mime type. event per offered mime type.
</description> </description>
<arg name="mime_type" type="string" summary="offered mime type"/> <arg name="mime_type" type="string" summary="offered mime type"/>
</event> </event>
@ -635,7 +630,6 @@
Used for feedback during drag-and-drop. Used for feedback during drag-and-drop.
</description> </description>
<arg name="mime_type" type="string" allow-null="true" summary="mime type accepted by the target"/> <arg name="mime_type" type="string" allow-null="true" summary="mime type accepted by the target"/>
</event> </event>
@ -645,7 +639,6 @@
specified mime type over the passed file descriptor, then specified mime type over the passed file descriptor, then
close it. close it.
</description> </description>
<arg name="mime_type" type="string" summary="mime type for the data"/> <arg name="mime_type" type="string" summary="mime type for the data"/>
<arg name="fd" type="fd" summary="file descriptor for the data"/> <arg name="fd" type="fd" summary="file descriptor for the data"/>
</event> </event>
@ -823,7 +816,6 @@
object will send out data_offer.offer events to describe the object will send out data_offer.offer events to describe the
mime types it offers. mime types it offers.
</description> </description>
<arg name="id" type="new_id" interface="wl_data_offer" summary="the new data_offer object"/> <arg name="id" type="new_id" interface="wl_data_offer" summary="the new data_offer object"/>
</event> </event>
@ -834,7 +826,6 @@
enter time is provided by the x and y arguments, in surface-local enter time is provided by the x and y arguments, in surface-local
coordinates. coordinates.
</description> </description>
<arg name="serial" type="uint" summary="serial number of the enter event"/> <arg name="serial" type="uint" summary="serial number of the enter event"/>
<arg name="surface" type="object" interface="wl_surface" summary="client surface entered"/> <arg name="surface" type="object" interface="wl_surface" summary="client surface entered"/>
<arg name="x" type="fixed" summary="surface-local x coordinate"/> <arg name="x" type="fixed" summary="surface-local x coordinate"/>
@ -1090,7 +1081,6 @@
The flags argument controls details of the transient behaviour. The flags argument controls details of the transient behaviour.
</description> </description>
<arg name="parent" type="object" interface="wl_surface" summary="parent surface"/> <arg name="parent" type="object" interface="wl_surface" summary="parent surface"/>
<arg name="x" type="int" summary="surface-local x coordinate"/> <arg name="x" type="int" summary="surface-local x coordinate"/>
<arg name="y" type="int" summary="surface-local y coordinate"/> <arg name="y" type="int" summary="surface-local y coordinate"/>
@ -1173,7 +1163,6 @@
corner of the surface relative to the upper left corner of the corner of the surface relative to the upper left corner of the
parent surface, in surface-local coordinates. parent surface, in surface-local coordinates.
</description> </description>
<arg name="seat" type="object" interface="wl_seat" summary="seat whose pointer is used"/> <arg name="seat" type="object" interface="wl_seat" summary="seat whose pointer is used"/>
<arg name="serial" type="uint" summary="serial number of the implicit grab on the pointer"/> <arg name="serial" type="uint" summary="serial number of the implicit grab on the pointer"/>
<arg name="parent" type="object" interface="wl_surface" summary="parent surface"/> <arg name="parent" type="object" interface="wl_surface" summary="parent surface"/>
@ -1260,7 +1249,6 @@
The width and height arguments specify the size of the window The width and height arguments specify the size of the window
in surface-local coordinates. in surface-local coordinates.
</description> </description>
<arg name="edges" type="uint" enum="resize" summary="how the surface was resized"/> <arg name="edges" type="uint" enum="resize" summary="how the surface was resized"/>
<arg name="width" type="int" summary="new width of the surface"/> <arg name="width" type="int" summary="new width of the surface"/>
<arg name="height" type="int" summary="new height of the surface"/> <arg name="height" type="int" summary="new height of the surface"/>
@ -1374,7 +1362,6 @@
If wl_surface.attach is sent with a NULL wl_buffer, the If wl_surface.attach is sent with a NULL wl_buffer, the
following wl_surface.commit will remove the surface content. following wl_surface.commit will remove the surface content.
</description> </description>
<arg name="buffer" type="object" interface="wl_buffer" allow-null="true" <arg name="buffer" type="object" interface="wl_buffer" allow-null="true"
summary="buffer of surface contents"/> summary="buffer of surface contents"/>
<arg name="x" type="int" summary="surface-local x coordinate"/> <arg name="x" type="int" summary="surface-local x coordinate"/>
@ -1405,7 +1392,6 @@
which uses buffer coordinates instead of surface coordinates, which uses buffer coordinates instead of surface coordinates,
and is probably the preferred and intuitive way of doing this. and is probably the preferred and intuitive way of doing this.
</description> </description>
<arg name="x" type="int" summary="surface-local x coordinate"/> <arg name="x" type="int" summary="surface-local x coordinate"/>
<arg name="y" type="int" summary="surface-local y coordinate"/> <arg name="y" type="int" summary="surface-local y coordinate"/>
<arg name="width" type="int" summary="width of damage rectangle"/> <arg name="width" type="int" summary="width of damage rectangle"/>
@ -1447,7 +1433,6 @@
The callback_data passed in the callback is the current time, in The callback_data passed in the callback is the current time, in
milliseconds, with an undefined base. milliseconds, with an undefined base.
</description> </description>
<arg name="callback" type="new_id" interface="wl_callback" summary="callback object for the frame request"/> <arg name="callback" type="new_id" interface="wl_callback" summary="callback object for the frame request"/>
</request> </request>
@ -1478,7 +1463,6 @@
destroyed immediately. A NULL wl_region causes the pending opaque destroyed immediately. A NULL wl_region causes the pending opaque
region to be set to empty. region to be set to empty.
</description> </description>
<arg name="region" type="object" interface="wl_region" allow-null="true" <arg name="region" type="object" interface="wl_region" allow-null="true"
summary="opaque region of the surface"/> summary="opaque region of the surface"/>
</request> </request>
@ -1508,7 +1492,6 @@
immediately. A NULL wl_region causes the input region to be set immediately. A NULL wl_region causes the input region to be set
to infinite. to infinite.
</description> </description>
<arg name="region" type="object" interface="wl_region" allow-null="true" <arg name="region" type="object" interface="wl_region" allow-null="true"
summary="input region of the surface"/> summary="input region of the surface"/>
</request> </request>
@ -1661,7 +1644,6 @@
two requests separately and only transform from one to the other two requests separately and only transform from one to the other
after receiving the wl_surface.commit. after receiving the wl_surface.commit.
</description> </description>
<arg name="x" type="int" summary="buffer-local x coordinate"/> <arg name="x" type="int" summary="buffer-local x coordinate"/>
<arg name="y" type="int" summary="buffer-local y coordinate"/> <arg name="y" type="int" summary="buffer-local y coordinate"/>
<arg name="width" type="int" summary="width of damage rectangle"/> <arg name="width" type="int" summary="width of damage rectangle"/>
@ -1828,7 +1810,6 @@
cursor ends, the current and pending input regions become cursor ends, the current and pending input regions become
undefined, and the wl_surface is unmapped. undefined, and the wl_surface is unmapped.
</description> </description>
<arg name="serial" type="uint" summary="serial number of the enter event"/> <arg name="serial" type="uint" summary="serial number of the enter event"/>
<arg name="surface" type="object" interface="wl_surface" allow-null="true" <arg name="surface" type="object" interface="wl_surface" allow-null="true"
summary="pointer surface"/> summary="pointer surface"/>
@ -1845,7 +1826,6 @@
is undefined and a client should respond to this event by setting is undefined and a client should respond to this event by setting
an appropriate pointer image with the set_cursor request. an appropriate pointer image with the set_cursor request.
</description> </description>
<arg name="serial" type="uint" summary="serial number of the enter event"/> <arg name="serial" type="uint" summary="serial number of the enter event"/>
<arg name="surface" type="object" interface="wl_surface" summary="surface entered by the pointer"/> <arg name="surface" type="object" interface="wl_surface" summary="surface entered by the pointer"/>
<arg name="surface_x" type="fixed" summary="surface-local x coordinate"/> <arg name="surface_x" type="fixed" summary="surface-local x coordinate"/>
@ -1870,7 +1850,6 @@
surface_x and surface_y are the location relative to the surface_x and surface_y are the location relative to the
focused surface. focused surface.
</description> </description>
<arg name="time" type="uint" summary="timestamp with millisecond granularity"/> <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="surface_x" type="fixed" summary="surface-local x coordinate"/> <arg name="surface_x" type="fixed" summary="surface-local x coordinate"/>
<arg name="surface_y" type="fixed" summary="surface-local y coordinate"/> <arg name="surface_y" type="fixed" summary="surface-local y coordinate"/>
@ -1894,7 +1873,6 @@
The time argument is a timestamp with millisecond The time argument is a timestamp with millisecond
granularity, with an undefined base. granularity, with an undefined base.
</description> </description>
<arg name="serial" type="uint" summary="serial number of the button event"/> <arg name="serial" type="uint" summary="serial number of the button event"/>
<arg name="time" type="uint" summary="timestamp with millisecond granularity"/> <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="button" type="uint" summary="button that produced the event"/> <arg name="button" type="uint" summary="button that produced the event"/>
@ -1928,7 +1906,6 @@
When applicable, a client can transform its content relative to the When applicable, a client can transform its content relative to the
scroll distance. scroll distance.
</description> </description>
<arg name="time" type="uint" summary="timestamp with millisecond granularity"/> <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="axis" type="uint" enum="axis" summary="axis type"/> <arg name="axis" type="uint" enum="axis" summary="axis type"/>
<arg name="value" type="fixed" summary="length of vector in surface-local coordinate space"/> <arg name="value" type="fixed" summary="length of vector in surface-local coordinate space"/>
@ -2155,7 +2132,6 @@
The time argument is a timestamp with millisecond The time argument is a timestamp with millisecond
granularity, with an undefined base. granularity, with an undefined base.
</description> </description>
<arg name="serial" type="uint" summary="serial number of the key event"/> <arg name="serial" type="uint" summary="serial number of the key event"/>
<arg name="time" type="uint" summary="timestamp with millisecond granularity"/> <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="key" type="uint" summary="key that produced the event"/> <arg name="key" type="uint" summary="key that produced the event"/>
@ -2167,7 +2143,6 @@
Notifies clients that the modifier and/or group state has Notifies clients that the modifier and/or group state has
changed, and it should update its local state. changed, and it should update its local state.
</description> </description>
<arg name="serial" type="uint" summary="serial number of the modifiers event"/> <arg name="serial" type="uint" summary="serial number of the modifiers event"/>
<arg name="mods_depressed" type="uint" summary="depressed modifiers"/> <arg name="mods_depressed" type="uint" summary="depressed modifiers"/>
<arg name="mods_latched" type="uint" summary="latched modifiers"/> <arg name="mods_latched" type="uint" summary="latched modifiers"/>
@ -2198,7 +2173,6 @@
so clients should continue listening for the event past the creation so clients should continue listening for the event past the creation
of wl_keyboard. of wl_keyboard.
</description> </description>
<arg name="rate" type="int" <arg name="rate" type="int"
summary="the rate of repeating keys in characters per second"/> summary="the rate of repeating keys in characters per second"/>
<arg name="delay" type="int" <arg name="delay" type="int"
@ -2315,7 +2289,6 @@
compositor will still be able to scan out directly from client compositor will still be able to scan out directly from client
surfaces. surfaces.
</description> </description>
<entry name="normal" value="0" summary="no transform"/> <entry name="normal" value="0" summary="no transform"/>
<entry name="90" value="1" summary="90 degrees counter-clockwise"/> <entry name="90" value="1" summary="90 degrees counter-clockwise"/>
<entry name="180" value="2" summary="180 degrees counter-clockwise"/> <entry name="180" value="2" summary="180 degrees counter-clockwise"/>
@ -2447,7 +2420,6 @@
<description summary="add rectangle to region"> <description summary="add rectangle to region">
Add the specified rectangle to the region. Add the specified rectangle to the region.
</description> </description>
<arg name="x" type="int" summary="region-local x coordinate"/> <arg name="x" type="int" summary="region-local x coordinate"/>
<arg name="y" type="int" summary="region-local y coordinate"/> <arg name="y" type="int" summary="region-local y coordinate"/>
<arg name="width" type="int" summary="rectangle width"/> <arg name="width" type="int" summary="rectangle width"/>
@ -2458,7 +2430,6 @@
<description summary="subtract rectangle from region"> <description summary="subtract rectangle from region">
Subtract the specified rectangle from the region. Subtract the specified rectangle from the region.
</description> </description>
<arg name="x" type="int" summary="region-local x coordinate"/> <arg name="x" type="int" summary="region-local x coordinate"/>
<arg name="y" type="int" summary="region-local y coordinate"/> <arg name="y" type="int" summary="region-local y coordinate"/>
<arg name="width" type="int" summary="rectangle width"/> <arg name="width" type="int" summary="rectangle width"/>
@ -2512,7 +2483,6 @@
must not have an existing wl_subsurface object. Otherwise a protocol must not have an existing wl_subsurface object. Otherwise a protocol
error is raised. error is raised.
</description> </description>
<arg name="id" type="new_id" interface="wl_subsurface" <arg name="id" type="new_id" interface="wl_subsurface"
summary="the new sub-surface object ID"/> summary="the new sub-surface object ID"/>
<arg name="surface" type="object" interface="wl_surface" <arg name="surface" type="object" interface="wl_surface"
@ -2609,7 +2579,6 @@
The initial position is 0, 0. The initial position is 0, 0.
</description> </description>
<arg name="x" type="int" summary="x coordinate in the parent surface"/> <arg name="x" type="int" summary="x coordinate in the parent surface"/>
<arg name="y" type="int" summary="y coordinate in the parent surface"/> <arg name="y" type="int" summary="y coordinate in the parent surface"/>
</request> </request>
@ -2632,7 +2601,6 @@
A new sub-surface is initially added as the top-most in the stack A new sub-surface is initially added as the top-most in the stack
of its siblings and parent. of its siblings and parent.
</description> </description>
<arg name="sibling" type="object" interface="wl_surface" <arg name="sibling" type="object" interface="wl_surface"
summary="the reference surface"/> summary="the reference surface"/>
</request> </request>
@ -2642,7 +2610,6 @@
The sub-surface is placed just below the reference surface. The sub-surface is placed just below the reference surface.
See wl_subsurface.place_above. See wl_subsurface.place_above.
</description> </description>
<arg name="sibling" type="object" interface="wl_surface" <arg name="sibling" type="object" interface="wl_surface"
summary="the reference surface"/> summary="the reference surface"/>
</request> </request>