Recently I've merged a patch that used hyphens in an attribute
name. I fixed it later, but turned out we don't document our
preference which is camelCase.
Suggested-by: Erik Skultety <eskultet@xxxxxxxxxx>
Signed-off-by: Michal Privoznik <mprivozn@xxxxxxxxxx>
---
I'm not sure this is the correct place to put this, suggestions welcome.
docs/api_extension.html.in | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/api_extension.html.in b/docs/api_extension.html.in
index 6c64e83314..d7696056ac 100644
--- a/docs/api_extension.html.in
+++ b/docs/api_extension.html.in
@@ -110,6 +110,12 @@
src/libvirt_public.syms
</code></p>
+ <p>
+ Please note that single word names for attributes and elements is
+ preferred. But if you have to use two ore more words please join them in
+ camelCase style.
+ </p>
+
<p>
This task is in many ways the most important to get right, since once
the API has been committed to the repository, it's libvirt's policy
--
2.26.2
