mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2026-04-06 07:15:47 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: fix cname-(suffix-)requirements

Browse source 
These used to be macro-like xml things that expanded to the text this
commit replaces them with.

Signed-off-by: Isaac Freund <mail@isaacfreund.com>
This commit is contained in:
Isaac Freund 2026-02-24 13:14:20 +01:00
parent 5231c0ee20
commit 72805582ee
No known key found for this signature in database
GPG key ID: 86DED400DDFD7A11
1 changed files with 20 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

28
doc/book/src/Message_XML.md
View file

@ -33,7 +33,9 @@ of the XML file.
**Required attributes** **Required attributes**
`name`="`cname`" `name`="`cname`"
: The name of the protocol (a.k.a protocol extension). cname-requirements : The name of the protocol (a.k.a protocol extension). The name must start
with one of the ASCII characters a-z, A-Z, or underscore, and the following
characters may additionally include numbers 0-9.
The name should be globally unique. Protocols to be included in The name should be globally unique. Protocols to be included in
[wayland-protocols](https://gitlab.freedesktop.org/wayland/wayland-protocols) [wayland-protocols](https://gitlab.freedesktop.org/wayland/wayland-protocols)
@ -116,7 +118,9 @@ usage of the interface.
**Required attributes** **Required attributes**
`name`="`cname`" `name`="`cname`"
: The name of the interface. cname-requirements The name must be unique in the : The name of the interface. The name must start with one of the ASCII
characters a-z, A-Z, or underscore, and the following characters may
additionally include numbers 0-9. The name must be unique in the
protocol, and preferably it should also be globally unique to avoid API protocol, and preferably it should also be globally unique to avoid API
conflicts in language bindings of multiple protocols. conflicts in language bindings of multiple protocols.
@ -174,7 +178,9 @@ The description element should be used to document the request.
**Required attributes** **Required attributes**
`name`="`cname`" `name`="`cname`"
: The name of the request. cname-requirements The name must be unique within : The name of the request. The name must start with one of the ASCII
characters a-z, A-Z, or underscore, and the following characters may
additionally include numbers 0-9. The name must be unique within
all requests and events in the containing interface. all requests and events in the containing interface.
Code and language binding generators may use the name in the API they Code and language binding generators may use the name in the API they
@ -238,8 +244,10 @@ The description element should be used to document the event.
**Required attributes** **Required attributes**
`name`="`cname`" `name`="`cname`"
: The name of the event. cname-requirements The name must be unique within all : The name of the event. The name must start with one of the ASCII characters
requests and events in the containing interface. a-z, A-Z, or underscore, and the following characters may additionally
include numbers 0-9. The name must be unique within all requests and events
in the containing interface.
Code and language binding generators may use the name in the API they Code and language binding generators may use the name in the API they
create. The `name` of the containing interface provides the namespace for create. The `name` of the containing interface provides the namespace for
@ -297,7 +305,9 @@ This element declares one argument for the request or the event.
**Required attributes** **Required attributes**
`name`="`cname`" `name`="`cname`"
: The name of the argument. cname-requirements The name must be unique within : The name of the argument. The name must start with one of the ASCII
characters a-z, A-Z, or underscore, and the following characters may
additionally include numbers 0-9. The name must be unique within
all the arguments of the parent element. all the arguments of the parent element.
`type`="`T`" `type`="`T`"
@ -435,7 +445,8 @@ integers.
**Required attributes** **Required attributes**
`name`="`cname-suffix`" `name`="`cname-suffix`"
: The name of the enumeration. cname-suffix-requirements The name must be : The name of the enumeration. The name must contain only the ASCII characters
a-z, A-Z, 0-9, or underscore. The name cannot be empty. The name must be
unique within all enumerations in the containing interface. The name is used unique within all enumerations in the containing interface. The name is used
as the namespace for all the contained entry elements. as the namespace for all the contained entry elements.
@ -465,7 +476,8 @@ the containing enumeration.
**Required attributes** **Required attributes**
`name`="`cname-suffix`" `name`="`cname-suffix`"
: The name of a value in an enumeration. cname-suffix-requirements The name : The name of a value in an enumeration. The name must contain only the ASCII
characters a-z, A-Z, 0-9, or underscore. The name cannot be empty. The name
must be unique within all entry elements in the containing enum. must be unique within all entry elements in the containing enum.
`value`="`V`" `value`="`V`"