From a3023a86ab42b0e6fb89a1e0856a73fa5f753ae1 Mon Sep 17 00:00:00 2001 From: Jonas Ådahl Date: Fri, 6 Nov 2015 12:33:01 +0800 Subject: README: Document interface naming convention MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Document that what different types of protocols should prefix their interfaces with. Signed-off-by: Jonas Ådahl --- README | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'README') diff --git a/README b/README index 2f58b1f..05fe5ca 100644 --- a/README +++ b/README @@ -51,6 +51,21 @@ describe above. If the changes are backward incompatible changes to an unstable protocol, see <>. +Interface naming convention +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +All protocols should avoid using generic namespaces or no namespaces in +the protocol interface names in order to minimize risk that the generated +C API collides with other C API. Interface names that may collide with +interface names from other protocols should also be avoided. + +For generic protocols not limited to certain configurations (such as +specific desktop environment or operating system) the +wp_+ prefix +should be used on all interfaces in the protocol. + +For operating system specific protocols, the interfaces should be +prefixed with both +wp_+ and the operating system, for example ++wp_linux_+, or +wp_freebsd_+, etc. + Unstable naming convention ~~~~~~~~~~~~~~~~~~~~~~~~~~ Unstable protocols have a special naming convention in order to make it -- cgit v1.2.3