Cc pdlogs 61

Updated after review comments.  
Modified the messages to capitalize acronyms.  
Removed unnecessary whitespace.  
Added full stop to end of each part of the message.  
Actions are numbered if there is more than one action.  This separates the individual actions.
Separated the log definitions with a blank line to make them more readable.  
Ran astyle (according to the coding standards) against craft_ent_definitions.h.
Added more comments to craft_ent_definitions.h.  
Kept the name PDLog (Problem Definition Log) as this describes what the classes are.  They enable Enhanced Node Troubleshooting which is what they do.
Fixed header file inconsistencies.
The review comment had: "A lot of the logs still say 'report issue to support' or something similar. This just isn't suitable for Project Clearwater."
The language was kept the same as this is what is done for the SNMP alarm definitions.  The associated documentation should identify the Metaswitch support team for ClearwaterCore and the Clearwater mailing list for Clearwater.
A type name was added for the PDLog enum.
Removed signalnames.cpp.  The signal call name is now obtained from the strsignal call.
Added CL_SCRIPT_ID to PDNodeType.
Not sure what you mean here.  I can just have this comment in pdlog.h and for cpp_common_pd_definitions.h state these are instances containing the Identity, Severity, etc.

David

From: Eleanor Merry [mailto:notifications@github.com]
Sent: Thursday, December 18, 2014 10:35 AM
To: Metaswitch/cpp-common
Cc: David Collins
Subject: Re: [cpp-common] Cc pdlogs 61 (#214)


In include/cpp_common_ent_definitions.h<https://github.com/Metaswitch/cpp-common/pull/214#discussion-diff-22052905>:

> +//   Identity - Identifies the log id to be used in the syslog id field.

> +//   Severity - One of Emergency, Alert, Critical, Error, Warning, Notice,

> +//              and Info.  Directly corresponds to the syslog severity types.

> +//              Only Error and Notice are used.  See syslog_facade.h for

> +//              definitions.

> +//   Message - Formatted description of the condition.

> +//   Cause - The cause of the condition.

> +//   Effect - The effect the condition.

> +//   Action - A list of one or more actions to take to resolve the condition

> +//           if it is an error.

> +// The elements of the class are used to format a syslog call.

> +// The call to output to syslog is in the method,  dcealog.

> +// By default syslog limits a total syslog message size to 2048 bytes.

> +// Anything above the limit is truncated.  The formatted message, cause,

> +// effect, and action(s) are concatenated into the syslog message.  Note,

> +// as an arbitrary convention, for more than a signle action, the actions

*single

—
Reply to this email directly or view it on GitHub<https://github.com/Metaswitch/cpp-common/pull/214/files#r22052905>.