]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: aesthetical cleanups
authorMartin Kletzander <mkletzan@redhat.com>
Mon, 17 Dec 2012 15:03:23 +0000 (16:03 +0100)
committerMartin Kletzander <mkletzan@redhat.com>
Wed, 30 Jan 2013 08:37:03 +0000 (09:37 +0100)
Adding dots inside "exempli gratia" where missing.  While on that, I
took the liberty of changing it where found with simple grep.

HACKING
docs/firewall.html.in
docs/formatdomain.html.in
docs/hacking.html.in
src/conf/domain_conf.c
src/locking/lock_driver.h

diff --git a/HACKING b/HACKING
index 3b800d81e14e5452c5b2e1d401a58045a96ce2ab..c7df3f30510e58264c18c6d22df844ad44b6e836 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -207,29 +207,29 @@ declare them at the beginning of a scope, rather than immediately before use.
 Bracket spacing
 ===============
 The keywords "if", "for", "while", and "switch" must have a single space
-following them before the opening bracket. eg
+following them before the opening bracket. E.g.
 
       if(foo)   // Bad
       if (foo)  // Good
 
-Function implementations mustnothave any whitespace between the function name and the opening bracket. eg
+Function implementations mustnothave any whitespace between the function name and the opening bracket. E.g.
 
       int foo (int wizz)  // Bad
       int foo(int wizz)   // Good
 
-Function calls mustnothave any whitespace between the function name and the opening bracket. eg
+Function calls mustnothave any whitespace between the function name and the opening bracket. E.g.
 
       bar = foo (wizz);  // Bad
       bar = foo(wizz);   // Good
 
 Function typedefs mustnothave any whitespace between the closing bracket of the function name and
-opening bracket of the arg list. eg
+opening bracket of the arg list. E.g.
 
       typedef int (*foo) (int wizz);  // Bad
       typedef int (*foo)(int wizz);   // Good
 
 There must not be any whitespace immediately following any opening bracket, or
-immediately prior to any closing bracket
+immediately prior to any closing bracket. E.g.
 
       int foo( int wizz );  // Bad
       int foo(int wizz);    // Good
index afc8dd3d6b4660f54f4696163f0c58c8a883eab8..a9af704e507ab3bee4496172e8de70a572d2a99a 100644 (file)
@@ -198,7 +198,7 @@ using an XML format. At a high level the format looks like this:
     </p>
     <p>The <code>&lt;rule&gt;</code> element is where all the interesting stuff
        happens. It has three attributes, an action, a traffic direction and an
-       optional priority. eg:
+       optional priority. E.g.:
     </p>
     <pre>&lt;rule action='drop' direction='out' priority='500'&gt;</pre>
     <p>Within the rule there are a wide variety of elements allowed, which
index 7ad8aea790c9db16006da3cb305cdc754b4ef1ac..c01f564eb38c7d6042139867925bf251004a48c1 100644 (file)
         attribute specifies the type of disk device to emulate;
         possible values are driver specific, with typical values being
         "ide", "scsi", "virtio", "xen", "usb" or "sata". If omitted, the bus
-        type is inferred from the style of the device name. eg, a device named
-        'sda' will typically be exported using a SCSI bus. The optional
+        type is inferred from the style of the device name (e.g. a device named
+        'sda' will typically be exported using a SCSI bus). The optional
         attribute <code>tray</code> indicates the tray status of the
         removable disks (i.e. CDROM or Floppy disk), the value can be either
         "open" or "closed", defaults to "closed". NB, the value of
index caec01a42dd7d8b8f53891f53944989c12edde7e..78620fce6770cb673dc034d5e794ee709a14d26c 100644 (file)
     <p>
       The keywords <code>if</code>, <code>for</code>, <code>while</code>,
       and <code>switch</code> must have a single space following them
-      before the opening bracket. eg
+      before the opening bracket. e.g.
     </p>
     <pre>
       if(foo)   // Bad
 
     <p>
       Function implementations must <strong>not</strong> have any whitespace
-      between the function name and the opening bracket. eg
+      between the function name and the opening bracket. e.g.
     </p>
     <pre>
       int foo (int wizz)  // Bad
 
     <p>
       Function calls must <strong>not</strong> have any whitespace
-      between the function name and the opening bracket. eg
+      between the function name and the opening bracket. e.g.
     </p>
     <pre>
       bar = foo (wizz);  // Bad
     <p>
       Function typedefs must <strong>not</strong> have any whitespace
       between the closing bracket of the function name and opening
-      bracket of the arg list. eg
+      bracket of the arg list. e.g.
     </p>
     <pre>
       typedef int (*foo) (int wizz);  // Bad
 
     <p>
       There must not be any whitespace immediately following any
-      opening bracket, or immediately prior to any closing bracket
+      opening bracket, or immediately prior to any closing bracket. e.g.
     </p>
     <pre>
       int foo( int wizz );  // Bad
index ac4b2c2b6f95952f824bc4d7763c1bc87fa22df6..abf2b6bcd951b34703edb7e4b6970d833241fc84 100644 (file)
@@ -3769,7 +3769,7 @@ virDomainDiskDefParseXML(virCapsPtr caps,
 
                 /* People sometimes pass a bogus '' source path
                    when they mean to omit the source element
-                   completely. eg CDROM without media. This is
+                   completely (e.g. CDROM without media). This is
                    just a little compatibility check to help
                    those broken apps */
                 if (source && STREQ(source, ""))
index e8ee226c54b63d291a2d6816ba7cf7f514ba7ce1..c4b162c749047e347072dc6042e68874eec5906a 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * lock_driver.h: Defines the lock driver plugin API
  *
- * Copyright (C) 2010-2011 Red Hat, Inc.
+ * Copyright (C) 2010-2011, 2013 Red Hat, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -186,8 +186,8 @@ typedef void (*virLockDriverFree)(virLockManagerPtr man);
  *
  * Assign a resource to a managed object. This will
  * only be called prior to the object is being locked
- * when it is inactive. eg, to set the initial  boot
- * time disk assignments on a VM
+ * when it is inactive (e.g. to set the initial  boot
+ * time disk assignments on a VM).
  * The format of @name varies according to
  * the resource @type. A VIR_LOCK_MANAGER_RESOURCE_TYPE_DISK
  * will have the fully qualified file path, while a resource