]> xenbits.xensource.com Git - libvirt.git/commitdiff
* HACKING: Clarify "bool" vs. XDR/wire-format.
authorJim Meyering <meyering@redhat.com>
Tue, 13 Jan 2009 10:45:41 +0000 (10:45 +0000)
committerJim Meyering <meyering@redhat.com>
Tue, 13 Jan 2009 10:45:41 +0000 (10:45 +0000)
ChangeLog
HACKING

index b1eae51ff5e73cdfe0ed06f6355b4271cc541262..556761523125192b5e09c7a563362cc786c29e1b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+Tue Jan 13 11:44:32 +0100 2009 Jim Meyering <meyering@redhat.com>
+
+       * HACKING: Clarify "bool" vs. XDR/wire-format.
+
 Mon Jan 12 22:07:57 CET 2009 Daniel Veillard <veillard@redhat.com>
 
        * docs/index.html docs/index.html.in docs/relatedlinks.html
diff --git a/HACKING b/HACKING
index ba036043eae15e908f170a8d7409355a16f6bb14..ca39d61d85f2aaa3991f13a540772932208be7cd 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -115,7 +115,10 @@ standard type like int32_t, uint32_t, uint64_t, etc.
 
 While using "bool" is good for readability, it comes with minor caveats:
  - Don't use "bool" in places where the type size must be constant across
-   all systems, like public interfaces and on-the-wire protocols.
+   all systems, like public interfaces and on-the-wire protocols.  Note
+   that it would be possible (albeit wasteful) to use "bool" in libvirt's
+   logical wire protocol, since XDR maps that to its lower-level bool_t
+   type, which *is* fixed-size.
  - Don't compare a bool variable against the literal, "true",
    since a value with a logical non-false value need not be "1".
    I.e., don't write "if (seen == true) ...".  Rather, write "if (seen)...".