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: changes should be submitted via GitLab

Browse source 
510188250e ("Add governance document") adds a GOVERNANCE document
describing development based on GitLab merge requests. Update the README
file accordingly.

Some information is duplicated across README and GOVERNANCE, this is
intentional to make README provide a more human-friendly, less
bureaucratic version. GOVERNANCE is still the authoritative version.

Signed-off-by: Simon Ser <contact@emersion.fr>
This commit is contained in:
Simon Ser 2019-11-20 22:49:27 +01:00
parent 3c30276063
commit 6d0fc70656
No known key found for this signature in database
GPG key ID: 0FDE7BE0E88F5E48
1 changed files with 19 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README
View file

@ -37,17 +37,18 @@ deprecated protocols are placed in the +deprecated/+ directory.
Protocol development procedure Protocol development procedure
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To propose a new protocol, create a patch adding the relevant files and To propose a new protocol, create a GitLab merge request adding the
Makefile.am entry to the wayland-protocols git repository with the relevant files and Makefile.am entry to the repository with the
explanation and motivation in the commit message. Then send the patch to explanation and motivation in the commit message. Protocols are
the wayland-devel@lists.freedesktop.org mailing list using organized in namespaces describing their scope ("wp", "xdg" and "ext").
'git send-email' with the subject prefix 'RFC wayland-protocols' or There are different requirements for each namespace, see GOVERNANCE
'PATCH wayland-protocols' depending on what state the protocol is in. section 2 for more information.
To propose changes to existing protocols, create a patch with the If the new protocol is just an idea, open an issue on the GitLab issue
changes and send it to the list mentioned above while also CC:ing the tracker. If the protocol isn't ready for complete review yet and is an
maintainers mentioned in the README file. Use the same rule for adding a RFC, create a merge request and add the "WIP:" prefix in the title.
subject prefix as above and method for sending the patch.
To propose changes to existing protocols, create a GitLab merge request.
If the changes are backward incompatible changes to an unstable protocol, If the changes are backward incompatible changes to an unstable protocol,
see <<Unstable protocol changes>>. see <<Unstable protocol changes>>.
@ -63,10 +64,15 @@ For generic protocols not limited to certain configurations (such as
specific desktop environment or operating system) the +wp_+ prefix specific desktop environment or operating system) the +wp_+ prefix
should be used on all interfaces in the protocol. should be used on all interfaces in the protocol.
For protocols allowing clients to configure how their windows are
managed, the +xdg_+ prefix should be used.
For operating system specific protocols, the interfaces should be For operating system specific protocols, the interfaces should be
prefixed with both +wp_+ and the operating system, for example prefixed with both +wp_+ and the operating system, for example
+wp_linux_+, or +wp_freebsd_+, etc. +wp_linux_+, or +wp_freebsd_+, etc.
For more information about namespaces, see GOVERNANCE section 2.1.
Unstable naming convention Unstable naming convention
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
Unstable protocols have a special naming convention in order to make it Unstable protocols have a special naming convention in order to make it
@ -135,6 +141,9 @@ The procedure of doing this is the following:
. Update the +README+ file in the unstable directory and create a new . Update the +README+ file in the unstable directory and create a new
+README+ file in the new directory. +README+ file in the new directory.
There are other requirements for declaring a protocol stable, see
GOVERNANCE section 2.3.
Releases Releases
~~~~~~~~ ~~~~~~~~
Each release of wayland-protocols finalizes the version of the protocols Each release of wayland-protocols finalizes the version of the protocols