]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: fix usage of 'onto'
authorEric Blake <eblake@redhat.com>
Fri, 19 Apr 2013 20:18:14 +0000 (14:18 -0600)
committerEric Blake <eblake@redhat.com>
Fri, 19 Apr 2013 20:31:16 +0000 (14:31 -0600)
http://www.uhv.edu/ac/newsletters/writing/grammartip2009.07.01.htm
(and several other sites) give hints that 'onto' is best used if
you can also add 'up' just before it and still make sense. In many
cases in the code base, we really want the two-word form, or even
a simplification to just 'on' or 'to'.

* docs/hacking.html.in: Use correct 'on to'.
* python/libvirt-override.c: Likewise.
* src/lxc/lxc_controller.c: Likewise.
* src/util/virpci.c: Likewise.
* daemon/THREADS.txt: Use simpler 'on'.
* docs/formatdomain.html.in: Better usage.
* docs/internals/rpc.html.in: Likewise.
* src/conf/domain_event.c: Likewise.
* src/rpc/virnetclient.c: Likewise.
* tests/qemumonitortestutils.c: Likewise.
* HACKING: Regenerate.

Signed-off-by: Eric Blake <eblake@redhat.com>
HACKING
daemon/THREADS.txt
docs/formatdomain.html.in
docs/hacking.html.in
docs/internals/rpc.html.in
python/libvirt-override.c
src/conf/domain_event.c
src/lxc/lxc_controller.c
src/rpc/virnetclient.c
src/util/virpci.c
tests/qemumonitortestutils.c

diff --git a/HACKING b/HACKING
index a648d54fe4110a9dea51470e65856f9d1dcc4b9c..e8bebd48e7e2a843ac4fa7c7de25bf2247cf8afb 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -330,7 +330,7 @@ Omitting braces with a single-line body is fine:
   while (expr) // one-line body -> omitting curly braces is ok
       single_line_stmt();
 
-However, the moment your loop/if/else body extends onto a second line, for
+However, the moment your loop/if/else body extends on to a second line, for
 whatever reason (even if it's just an added comment), then you should add
 braces. Otherwise, it would be too easy to insert a statement just before that
 comment (without adding braces), thinking it is already a multi-statement loop:
index 6386941da50b8cbfb89cf20af09cf9125b2dede0..762ca25c555d3f14c48a1c54e167071a8ffc9774 100644 (file)
@@ -40,7 +40,7 @@ The server lock is used in conjunction with a condition variable
 to pass jobs from the event loop thread to the workers. The main
 event loop thread handles I/O from the client socket, and once a
 complete RPC message has been read off the wire (and optionally
-decrypted), it will be placed onto the 'dx' job queue for the
+decrypted), it will be placed on the 'dx' job queue for the
 associated client object. The job condition will be signalled and
 a worker will wakup and process it.
 
index 0cc56d934c686931b75435156dac1a0e9cb4398a..888c005982da044bc5e0d4ac669910b2bb3a2f96 100644 (file)
 
     <p>
       Resource partitions are currently supported by the QEMU and
-      LXC drivers, which map partition paths onto cgroups directories,
+      LXC drivers, which map partition paths to cgroups directories,
       in all mounted controllers. <span class="since">Since 1.0.5</span>
     </p>
 
     </p>
 
     <p>
-      Provides a bridge from the VM directly onto the LAN. This assumes
+      Provides a bridge from the VM directly to the LAN. This assumes
       there is a bridge device on the host which has one or more of the hosts
       physical NICs enslaved. The guest VM will have an associated tun device
       created with a name of vnetN, which can also be overridden with the
     <dl>
       <dt><code>profileid</code></dt>
       <dd>The profile ID contains the name of the port profile that is to
-        be applied onto this interface.  This name is resolved by the port
+        be applied to this interface.  This name is resolved by the port
         profile database into the network parameters from the port profile,
         and those network parameters will be applied to this interface.
       </dd>
index 632d357a4e753bf18182dbc94f6b69d859e34196..99933d1dda59e428cba4425373f356b591a0dba4 100644 (file)
 </pre>
 
     <p>
-      However, the moment your loop/if/else body extends onto a second
+      However, the moment your loop/if/else body extends on to a second
       line, for whatever reason (even if it's just an added comment), then
       you should add braces.  Otherwise, it would be too easy to insert a
       statement just before that comment (without adding braces), thinking
index 4cf1e380c534151ab8cf6e4866d91006e779a22f..91e8449b1d16136007dee409461e4b4b94049761 100644 (file)
       After a complete packet has been read, the header must be decoded
       and all 6 fields fully validated, before attempting to dispatch
       the payload. Once dispatched, the payload can be decoded and passed
-      onto the appropriate API for execution. The RPC code must not take
+      on to the appropriate API for execution. The RPC code must not take
       any action based on the payload, since it has no way to validate
       the semantics of the payload data. It must delegate this to the
       execution API (e.g. corresponding libvirt public API).
       return value and output parameters, or error object and encode
       them into a reply packet. Again it does not attempt to do any
       semantic validation of output data, aside from variable length
-      field limit checks. The worker thread puts the reply packet onto
+      field limit checks. The worker thread puts the reply packet on
       the transmission queue for the client. The worker is now finished
       and goes back to wait for another incoming method call.
     </p>
       for the worker threads, it is sidetracked into a per-stream
       processing queue. When the stream becomes writable, queued
       incoming stream packets will be processed, passing their data
-      payload onto the stream. Conversely when the stream becomes
+      payload on the stream. Conversely when the stream becomes
       readable, chunks of data will be read from it, encoded into
       new outgoing packets, and placed on the client's transmit
-      queue
+      queue.
     </p>
 
     <h4><a name="apiserverdispatchex1">Example with overlapping methods</a></h4>
index 3d8490c0721e7bbb0ceb734c2ea8ef3601a515d5..244b7ec5e51e55ce6ebb26f4a122dbdff8d3394d 100644 (file)
@@ -4,7 +4,7 @@
  *           entry points where an automatically generated stub is
  *           unpractical
  *
- * Copyright (C) 2005, 2007-2012 Red Hat, Inc.
+ * Copyright (C) 2005, 2007-2013 Red Hat, Inc.
  *
  * Daniel Veillard <veillard@redhat.com>
  */
@@ -5084,7 +5084,7 @@ libvirt_virEventRegisterImpl(ATTRIBUTE_UNUSED PyObject * self,
     updateTimeoutName = py_str(updateTimeoutObj);
     removeTimeoutName = py_str(removeTimeoutObj);
 
-    /* Inc refs since we're holding onto these objects until
+    /* Inc refs since we're holding on to these objects until
      * the next call (if any) to this function.
      */
     Py_INCREF(addHandleObj);
index 96a07ac66788a7a3fde2c9367b2bcece6b672eea..825012a1456e5ec7531056719046f1915167ccf5 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * domain_event.c: domain event queue processing helpers
  *
- * Copyright (C) 2010-2012 Red Hat, Inc.
+ * Copyright (C) 2010-2013 Red Hat, Inc.
  * Copyright (C) 2008 VirtualIron
  *
  * This library is free software; you can redistribute it and/or
@@ -1179,7 +1179,7 @@ virDomainEventPtr virDomainEventBalloonChangeNewFromObj(virDomainObjPtr obj,
  * @evtQueue: the dom event queue
  * @event: the event to add
  *
- * Internal function to push onto the back of a virDomainEventQueue
+ * Internal function to push to the back of a virDomainEventQueue
  *
  * Returns: 0 on success, -1 on failure
  */
index f46f813424018314ff5e615e0c9303e2f0ab97dc..740b87256e8d79c31be621318fa06a91d7a9f72e 100644 (file)
@@ -1699,7 +1699,7 @@ int main(int argc, char *argv[])
             _exit(0);
         }
 
-        /* Don't hold onto any cwd we inherit from libvirtd either */
+        /* Don't hold on to any cwd we inherit from libvirtd either */
         if (chdir("/") < 0) {
             virReportSystemError(errno, "%s",
                                  _("Unable to change to root dir"));
index 010c5c36d9cd2da42e0eccc3e2d8cfb7fa158cee..1d228f0a7442bb264950c4f050429dd0e18bc381 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * virnetclient.c: generic network RPC client
  *
- * Copyright (C) 2006-2012 Red Hat, Inc.
+ * Copyright (C) 2006-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
@@ -1771,7 +1771,7 @@ static int virNetClientIO(virNetClientPtr client,
             goto cleanup;
         }
 
-        /* Grr, someone passed the buck onto us ... */
+        /* Grr, someone passed the buck to us ... */
     } else {
         client->haveTheBuck = true;
     }
index d94ff54f12a84ad835a56a905b1a0fb740d9ab25..e58010b42e34abc51dd9a9b3897eef52e1c7f4f9 100644 (file)
@@ -1208,8 +1208,8 @@ virPCIDeviceReattach(virPCIDevicePtr dev,
  * condition where the hypervisor is still cleaning up the device while
  * libvirt is trying to re-attach it to the host device driver.  To avoid
  * this situation, we look through /proc/iomem, and if the hypervisor is
- * still holding onto the bar (denoted by the string in the matcher variable),
- * then we can wait around a bit for that to clear up.
+ * still holding on to the bar (denoted by the string in the matcher
+ * variable), then we can wait around a bit for that to clear up.
  *
  * A typical /proc/iomem looks like this (snipped for brevity):
  * 00010000-0008efff : System RAM
@@ -1230,7 +1230,7 @@ virPCIDeviceReattach(virPCIDevicePtr dev,
  *   f0000000-f0003fff : kvm_assigned_device
  *
  * Returns 0 if we are clear to continue, and 1 if the hypervisor is still
- * holding onto the resource.
+ * holding on to the resource.
  */
 int
 virPCIDeviceWaitForCleanup(virPCIDevicePtr dev, const char *matcher)
index fe98813a187823243ac9a15cacfe6bef5ce24dfd..43e7cb904a9500ac427f7ff2d0195ba7e6c82c93 100644 (file)
@@ -77,7 +77,7 @@ struct _qemuMonitorTest {
 static void qemuMonitorTestItemFree(qemuMonitorTestItemPtr item);
 
 /*
- * Appends data for a reply onto the outgoing buffer
+ * Appends data for a reply to the outgoing buffer
  */
 static int qemuMonitorTestAddReponse(qemuMonitorTestPtr test,
                                      const char *response)