aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorBalint Reczey <balint@balintreczey.hu>2016-06-15 14:14:23 -0700
committerAnders Broman <a.broman58@gmail.com>2016-06-15 21:21:54 +0000
commita8f73e92fde0b7055004e4d3d518ffcfd447815c (patch)
tree2b99787931906d2b31babe767e4770fb391acc9d /doc
parent04058b8af3e36070721e807ae0ecdac4b411a5dc (diff)
documentation: Suggest using prefixed public symbols
Change-Id: I9153756b0e921fd74d7df9d119337f5484856ba0 Reviewed-on: https://code.wireshark.org/review/15940 Reviewed-by: Anders Broman <a.broman58@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/README.developer5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/README.developer b/doc/README.developer
index 45868e5208..d7e5a09af1 100644
--- a/doc/README.developer
+++ b/doc/README.developer
@@ -659,6 +659,11 @@ intercaps for functions and variable names. This is especially important if you
are writing code that will be called from outside your code. We are just
trying to keep things consistent for other developers.
+C symbols exported from libraries shipped with Wireshark should start with a
+prefix that helps avoiding name collision with public symbols from other shared
+libraries. The current suggested prefixes for newly added symbols are
+ws_, wslua_, wmem_ and wtap_.
+
5. White space convention.
Please avoid using tab expansions different from 8 column widths, as not all