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.
This commit is contained in:
Martin Kletzander 2012-12-17 16:03:23 +01:00
parent 1f50730e44
commit 901f4b6b86
6 changed files with 17 additions and 17 deletions

10
HACKING
View File

@ -207,29 +207,29 @@ declare them at the beginning of a scope, rather than immediately before use.
Bracket spacing Bracket spacing
=============== ===============
The keywords "if", "for", "while", and "switch" must have a single space 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) // Bad
if (foo) // Good 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) // Bad
int foo(int wizz) // Good 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); // Bad
bar = foo(wizz); // Good bar = foo(wizz); // Good
Function typedefs mustnothave any whitespace between the closing bracket of the function name and 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); // Bad
typedef int (*foo)(int wizz); // Good typedef int (*foo)(int wizz); // Good
There must not be any whitespace immediately following any opening bracket, or 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 ); // Bad
int foo(int wizz); // Good int foo(int wizz); // Good

View File

@ -198,7 +198,7 @@ using an XML format. At a high level the format looks like this:
</p> </p>
<p>The <code>&lt;rule&gt;</code> element is where all the interesting stuff <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 happens. It has three attributes, an action, a traffic direction and an
optional priority. eg: optional priority. E.g.:
</p> </p>
<pre>&lt;rule action='drop' direction='out' priority='500'&gt;</pre> <pre>&lt;rule action='drop' direction='out' priority='500'&gt;</pre>
<p>Within the rule there are a wide variety of elements allowed, which <p>Within the rule there are a wide variety of elements allowed, which

View File

@ -1492,8 +1492,8 @@
attribute specifies the type of disk device to emulate; attribute specifies the type of disk device to emulate;
possible values are driver specific, with typical values being possible values are driver specific, with typical values being
"ide", "scsi", "virtio", "xen", "usb" or "sata". If omitted, the bus "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 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 'sda' will typically be exported using a SCSI bus). The optional
attribute <code>tray</code> indicates the tray status of the attribute <code>tray</code> indicates the tray status of the
removable disks (i.e. CDROM or Floppy disk), the value can be either removable disks (i.e. CDROM or Floppy disk), the value can be either
"open" or "closed", defaults to "closed". NB, the value of "open" or "closed", defaults to "closed". NB, the value of

View File

@ -241,7 +241,7 @@
<p> <p>
The keywords <code>if</code>, <code>for</code>, <code>while</code>, The keywords <code>if</code>, <code>for</code>, <code>while</code>,
and <code>switch</code> must have a single space following them and <code>switch</code> must have a single space following them
before the opening bracket. eg before the opening bracket. e.g.
</p> </p>
<pre> <pre>
if(foo) // Bad if(foo) // Bad
@ -250,7 +250,7 @@
<p> <p>
Function implementations must <strong>not</strong> have any whitespace 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> </p>
<pre> <pre>
int foo (int wizz) // Bad int foo (int wizz) // Bad
@ -259,7 +259,7 @@
<p> <p>
Function calls must <strong>not</strong> have any whitespace 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> </p>
<pre> <pre>
bar = foo (wizz); // Bad bar = foo (wizz); // Bad
@ -269,7 +269,7 @@
<p> <p>
Function typedefs must <strong>not</strong> have any whitespace Function typedefs must <strong>not</strong> have any whitespace
between the closing bracket of the function name and opening between the closing bracket of the function name and opening
bracket of the arg list. eg bracket of the arg list. e.g.
</p> </p>
<pre> <pre>
typedef int (*foo) (int wizz); // Bad typedef int (*foo) (int wizz); // Bad
@ -278,7 +278,7 @@
<p> <p>
There must not be any whitespace immediately following any 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> </p>
<pre> <pre>
int foo( int wizz ); // Bad int foo( int wizz ); // Bad

View File

@ -3769,7 +3769,7 @@ virDomainDiskDefParseXML(virCapsPtr caps,
/* People sometimes pass a bogus '' source path /* People sometimes pass a bogus '' source path
when they mean to omit the source element 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 just a little compatibility check to help
those broken apps */ those broken apps */
if (source && STREQ(source, "")) if (source && STREQ(source, ""))

View File

@ -1,7 +1,7 @@
/* /*
* lock_driver.h: Defines the lock driver plugin API * 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 * This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public * 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 * Assign a resource to a managed object. This will
* only be called prior to the object is being locked * only be called prior to the object is being locked
* when it is inactive. eg, to set the initial boot * when it is inactive (e.g. to set the initial boot
* time disk assignments on a VM * time disk assignments on a VM).
* The format of @name varies according to * The format of @name varies according to
* the resource @type. A VIR_LOCK_MANAGER_RESOURCE_TYPE_DISK * the resource @type. A VIR_LOCK_MANAGER_RESOURCE_TYPE_DISK
* will have the fully qualified file path, while a resource * will have the fully qualified file path, while a resource