diff options
author | Simon Horman <horms@verge.net.au> | 2012-09-05 11:50:36 +0900 |
---|---|---|
committer | Ben Pfaff <blp@nicira.com> | 2012-09-05 10:04:48 -0700 |
commit | 4b83c93f19424c4b7c02c8ce25f2a689fc6a7369 (patch) | |
tree | 0de05c74e4889df05fe4a9f535aa9a34f7693049 /lib/ofp-errors.h | |
parent | ed815d9bd28422a490fe370d7804d24bcd676806 (diff) |
ofp-errors: Ignore text enclosed in square brackets
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@nicira.com>
Signed-off-by: Simon Horman <horms@verge.net.au>
[blp@nicira.com added the large comment on enum ofperr.]
Signed-off-by: Ben Pfaff <blp@nicira.com>
Diffstat (limited to 'lib/ofp-errors.h')
-rw-r--r-- | lib/ofp-errors.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/ofp-errors.h b/lib/ofp-errors.h index cdeddc9b..e361223b 100644 --- a/lib/ofp-errors.h +++ b/lib/ofp-errors.h @@ -45,6 +45,19 @@ struct ofpbuf; #define OFPERR_OFS (1 << 30) +/* 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. */ enum ofperr { /* Expected duplications. */ |