[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [PATCH v2 2/3] docs: aesthetical cleanups



Adding dots inside "exempli gratia" where missing.  While on that, I
took the liberty of changing it where found with simple grep.
---
v2:
 - I git grep'd the whole repo and fixed it everywhere, not just in
   HACKING
---
 HACKING                   | 10 +++++-----
 docs/firewall.html.in     |  2 +-
 docs/formatdomain.html.in |  4 ++--
 docs/hacking.html.in      | 10 +++++-----
 src/conf/domain_conf.c    |  2 +-
 src/locking/lock_driver.h |  6 +++---
 6 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/HACKING b/HACKING
index 3b800d8..c7df3f3 100644
--- 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
diff --git a/docs/firewall.html.in b/docs/firewall.html.in
index afc8dd3..a9af704 100644
--- a/docs/firewall.html.in
+++ b/docs/firewall.html.in
@@ -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
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 7ad8aea..c01f564 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -1492,8 +1492,8 @@
         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
diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index caec01a..78620fc 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -241,7 +241,7 @@
     <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
@@ -250,7 +250,7 @@

     <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
@@ -259,7 +259,7 @@

     <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
@@ -269,7 +269,7 @@
     <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
@@ -278,7 +278,7 @@

     <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
diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c
index ac4b2c2..abf2b6b 100644
--- a/src/conf/domain_conf.c
+++ b/src/conf/domain_conf.c
@@ -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, ""))
diff --git a/src/locking/lock_driver.h b/src/locking/lock_driver.h
index e8ee226..c4b162c 100644
--- a/src/locking/lock_driver.h
+++ b/src/locking/lock_driver.h
@@ -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
--
1.8.1.2


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]