fdo-mirrors/wayland-protocols
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland-protocols.git synced 2025-12-20 08:10:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

README: typo fixes

Browse source 
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
This commit is contained in:
Pekka Paalanen 2015-11-05 09:56:19 +02:00 • committed by Jonas Ådahl
parent 0030020eb8
commit 2f06d21c60
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README
View file

@ -57,8 +57,8 @@ Unstable protocols have a special naming convention in order to make it
possible to make discoverable backward incompatible changes. possible to make discoverable backward incompatible changes.
An unstable protocol has at least two versions; the major version which An unstable protocol has at least two versions; the major version which
are represents backward incompatible changes, and the minor versions, represents backward incompatible changes, and the minor versions
which represents backward compatible changes to the interfaces in the which represent backward compatible changes to the interfaces in the
protocol. protocol.
The major version is part of the XML file name and the protocol name in The major version is part of the XML file name and the protocol name in
@ -71,10 +71,10 @@ postfixed with the major version number.
For example, an unstable protocol called foo-bar with major version 2 For example, an unstable protocol called foo-bar with major version 2
containing the two interfaces wl_foo and wl_bar both minor version 1 will containing the two interfaces wl_foo and wl_bar both minor version 1 will
a directory called +foo-bar/+ placed in the directory +unstable/+ be placed in the directory +unstable/foo-bar/+
consisting of one file called +README+ and one called consisting of one file called +README+ and one called
+foo-bar-unstable-v2.xml+. The XML file will consist of two interfaces +foo-bar-unstable-v2.xml+. The XML file will consist of two interfaces
called +zwl_foo2+ and +zwl_foo2+ with the +version+ attribute set to +1+. called +zwl_foo2+ and +zwl_bar2+ with the +version+ attribute set to +1+.
Unstable protocol changes Unstable protocol changes
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
@ -108,7 +108,7 @@ The procedure of doing this is the following:
. Copy the final version of the XML that is the version that was . Copy the final version of the XML that is the version that was
decided to be declared stable into the new directory. The target name decided to be declared stable into the new directory. The target name
should be the same name as the protocol directory but with the +.xml+ should be the same name as the protocol directory but with the +.xml+
prefix. suffix.
. Rename the name of the protocol in the XML by removing the . Rename the name of the protocol in the XML by removing the
'unstable' part and the major version number. 'unstable' part and the major version number.
. Remove the +z+ prefix and the major version number postfix from all . Remove the +z+ prefix and the major version number postfix from all