[ovs-dev] [PATCH] ovsdb-idl: Document that the IDL always presents a consistent view.

[Russell Bryant]

On 06/10/2015 11:15 AM, Ben Pfaff wrote:
> We've had this question a couple of times so we might as well document it.
> 
> Requested-by: Saurabh Shrivastava (सौरभ श्रीवास्तव) <saurabh at gmail.com>
> Signed-off-by: Ben Pfaff <blp at nicira.com>
> ---
>  AUTHORS         | 1 +
>  lib/ovsdb-idl.h | 6 +++++-
>  2 files changed, 6 insertions(+), 1 deletion(-)
> 
> diff --git a/AUTHORS b/AUTHORS
> index 5ad3c1a..fb4ebb6 100644
> --- a/AUTHORS
> +++ b/AUTHORS
> @@ -328,6 +328,7 @@ Ronaldo A. Ferreira     ronaldof at CS.Princeton.EDU
>  Ronny L. Bull           bullrl at clarkson.edu
>  Sander Eikelenboom      linux at eikelenboom.it
>  Saul St. John           sstjohn at cs.wisc.edu
> +Saurabh Shrivastava (सौरभ श्रीवास्तव)    saurabh at gmail.com
>  Scott Hendricks         shendricks at nicira.com
>  Sean Brady              sbrady at gtfservices.com
>  Sebastian Andrzej Siewior  sebastian at breakpoint.cc
> diff --git a/lib/ovsdb-idl.h b/lib/ovsdb-idl.h
> index 54df90d..d0c025a 100644
> --- a/lib/ovsdb-idl.h
> +++ b/lib/ovsdb-idl.h
> @@ -1,4 +1,4 @@
> -/* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
> +/* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
>   *
>   * Licensed under the Apache License, Version 2.0 (the "License");
>   * you may not use this file except in compliance with the License.
> @@ -23,6 +23,10 @@
>   * raw JSON into data structures that are easier for clients to digest.  Most
>   * notably, references to rows via UUID become C pointers.
>   *
> + * The IDL always presents a consistent snapshot of the database to its client,
> + * that is, it won't present the effects of some part of a transaction applied
> + * at the database server without presenting all of its.
> + *

The addition seems like a good one, but the last sentence ends weird,
like a word was left off.  Maybe "its changes." ?

-- 
Russell Bryant