[ovs-dev] [PATCH 1/3] ofp-errors: Ignore text enclosed in square brackets

[Simon Horman]

On Wed, Sep 05, 2012 at 10:06:40AM -0700, Ben Pfaff wrote:
> On Wed, Sep 05, 2012 at 11:50:36AM +0900, Simon Horman wrote:
> > Enhance to extract-ofp-errors to omit text enclosed in square brackets from
> > error description. This allows some commentary other than
> > the error description to be supplied in ofp-errors.h
> > 
> > As suggested by Ben Pfaff <blp at nicira.com>
> > 
> > Signed-off-by: Simon Horman <horms at verge.net.au>
> > 
> > ---
> > 
> > I chose not to use the alternate suggestion of terminating descriptions
> > on new line as there are several examples of descriptions that span
> > multiple lines in ofp-errors.h
> > 
> > v2
> > * Initial post
> 
> I applied this but added a comment on enum ofperr to explain what's
> going on:

Thanks.

> 
> /* OpenFlow error codes.
>  *
>  * The comments below are parsed by the extract-ofp-errors program at build
>  * time and used to determine the mapping between "enum ofperr" constants and
>  * error type/code values used in the OpenFlow protocol:
>  *
>  *   - The first part of each comment specifies OpenFlow type/code for each
>  *     protocol that supports the error.
>  *
>  *   - Additional text is a human-readable description of the meaning of each
>  *     error, used to explain the error to the user.  Any text enclosed in
>  *     square brackets is omitted; this can be used to explain rationale for
>  *     choice of error codes in the case where this is desirable. */
>