Patchwork ui/vnc-jobs.c: Fix minor typos in comments

login
register
mail settings
Submitter Peter Maydell
Date Oct. 18, 2012, 3:03 p.m.
Message ID <1350572612-24268-1-git-send-email-peter.maydell@linaro.org>
Download mbox | patch
Permalink /patch/192347/
State New
Headers show

Comments

Peter Maydell - Oct. 18, 2012, 3:03 p.m.
Fix some minor typos/grammar errors in comments.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
 ui/vnc-jobs.c |   16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
Stefan Weil - Oct. 18, 2012, 4:09 p.m.
Please see my comments below.

Am 18.10.2012 17:03, schrieb Peter Maydell:
> Fix some minor typos/grammar errors in comments.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>   ui/vnc-jobs.c |   16 ++++++++--------
>   1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/ui/vnc-jobs.c b/ui/vnc-jobs.c
> index 087b84d..84b074e 100644
> --- a/ui/vnc-jobs.c
> +++ b/ui/vnc-jobs.c
> @@ -33,21 +33,21 @@
>   /*
>    * Locking:
>    *
> - * There is three levels of locking:
> + * There are three levels of locking:
>    * - jobs queue lock: for each operation on the queue (push, pop, isEmpty?)
>    * - VncDisplay global lock: mainly used for framebuffer updates to avoid
>    *                      screen corruption if the framebuffer is updated
> - *			while the worker is doing something.
> + *                      while the worker is doing something.
>    * - VncState::output lock: used to make sure the output buffer is not corrupted
> - * 		   	 if two threads try to write on it at the same time
> + *                          two threads try to write on it at the same time


Did you remove the 'if' intentionally? Then I'd expect a comma after
'corrupted', because 'two threads try to write ...' is a new sentence.


>    *
> - * While the VNC worker thread is working, the VncDisplay global lock is hold
> - * to avoid screen corruptions (this does not block vnc_refresh() because it
> - * uses trylock()) but the output lock is not hold because the thread work on
> + * While the VNC worker thread is working, the VncDisplay global lock is held
> + * to avoid screen corruption (this does not block vnc_refresh() because it
> + * uses trylock()) but the output lock is not held because the thread works on
>    * its own output buffer.
>    * When the encoding job is done, the worker thread will hold the output lock
>    * and copy its output buffer in vs->output.
> -*/
> + */
>   
>   struct VncJobQueue {
>       QemuCond cond;
> @@ -62,7 +62,7 @@ typedef struct VncJobQueue VncJobQueue;
>   
>   /*
>    * We use a single global queue, but most of the functions are
> - * already reetrant, so we can easilly add more than one encoding thread
> + * already reentrant, so we can easily add more than one encoding thread
>    */
>   static VncJobQueue *queue;


Reviewed-by: Stefan Weil <sw@weilnetz.de>

Cheers
Stefan
Peter Maydell - Oct. 18, 2012, 4:38 p.m.
On 18 October 2012 17:09, Stefan Weil <sw@weilnetz.de> wrote:
> Am 18.10.2012 17:03, schrieb Peter Maydell:
>> - *                      if two threads try to write on it at the same
>> time
>> + *                          two threads try to write on it at the same
>> time
>
>
>
> Did you remove the 'if' intentionally? Then I'd expect a comma after
> 'corrupted', because 'two threads try to write ...' is a new sentence.

No, that was a careless error on my part; the edit was just intended to
remove the hard tabs on that line. I'll send a fixed patch.

-- PMM

Patch

diff --git a/ui/vnc-jobs.c b/ui/vnc-jobs.c
index 087b84d..84b074e 100644
--- a/ui/vnc-jobs.c
+++ b/ui/vnc-jobs.c
@@ -33,21 +33,21 @@ 
 /*
  * Locking:
  *
- * There is three levels of locking:
+ * There are three levels of locking:
  * - jobs queue lock: for each operation on the queue (push, pop, isEmpty?)
  * - VncDisplay global lock: mainly used for framebuffer updates to avoid
  *                      screen corruption if the framebuffer is updated
- *			while the worker is doing something.
+ *                      while the worker is doing something.
  * - VncState::output lock: used to make sure the output buffer is not corrupted
- * 		   	 if two threads try to write on it at the same time
+ *                          two threads try to write on it at the same time
  *
- * While the VNC worker thread is working, the VncDisplay global lock is hold
- * to avoid screen corruptions (this does not block vnc_refresh() because it
- * uses trylock()) but the output lock is not hold because the thread work on
+ * While the VNC worker thread is working, the VncDisplay global lock is held
+ * to avoid screen corruption (this does not block vnc_refresh() because it
+ * uses trylock()) but the output lock is not held because the thread works on
  * its own output buffer.
  * When the encoding job is done, the worker thread will hold the output lock
  * and copy its output buffer in vs->output.
-*/
+ */
 
 struct VncJobQueue {
     QemuCond cond;
@@ -62,7 +62,7 @@  typedef struct VncJobQueue VncJobQueue;
 
 /*
  * We use a single global queue, but most of the functions are
- * already reetrant, so we can easilly add more than one encoding thread
+ * already reentrant, so we can easily add more than one encoding thread
  */
 static VncJobQueue *queue;