diff options
Diffstat (limited to 'libglusterfs/src/template-component-messages.h')
-rw-r--r-- | libglusterfs/src/template-component-messages.h | 46 |
1 files changed, 14 insertions, 32 deletions
diff --git a/libglusterfs/src/template-component-messages.h b/libglusterfs/src/template-component-messages.h index 7a6d0d14e17..0f0062a5d7c 100644 --- a/libglusterfs/src/template-component-messages.h +++ b/libglusterfs/src/template-component-messages.h @@ -13,38 +13,20 @@ #include "glfs-message-id.h" -/* NOTE: Rules for message additions - * 1) Each instance of a message is _better_ left with a unique message ID, even - * if the message format is the same. Reasoning is that, if the message - * format needs to change in one instance, the other instances are not - * impacted or the new change does not change the ID of the instance being - * modified. - * 2) Addition of a message, - * - Should increment the GLFS_NUM_MESSAGES - * - Append to the list of messages defined, towards the end - * - Retain macro naming as glfs_msg_X (for redability across developers) - * NOTE: Rules for message format modifications - * 3) Check acorss the code if the message ID macro in question is reused - * anywhere. If reused then then the modifications should ensure correctness - * everywhere, or needs a new message ID as (1) above was not adhered to. If - * not used anywhere, proceed with the required modification. - * NOTE: Rules for message deletion - * 4) Check (3) and if used anywhere else, then cannot be deleted. If not used - * anywhere, then can be deleted, but will leave a hole by design, as - * addition rules specify modification to the end of the list and not filling - * holes. +/* To add new message IDs, append new identifiers at the end of the list. + * + * Never remove a message ID. If it's not used anymore, you can rename it or + * leave it as it is, but not delete it. This is to prevent reutilization of + * IDs by other messages. + * + * The component name must match one of the entries defined in + * glfs-message-id.h. */ -#define GLFS_COMP_BASE GLFS_MSGID_COMP_<component> -#define GLFS_NUM_MESSAGES 1 -#define GLFS_MSGID_END (GLFS_COMP_BASE + GLFS_NUM_MESSAGES + 1) -/* Messaged with message IDs */ -#define glfs_msg_start_x GLFS_COMP_BASE, "Invalid: Start of messages" -/*------------*/ -#define <component>_msg_1 (GLFS_COMP_BASE + 1), "Test message, replace with"\ - " original when using the template" +GLFS_MSGID(component, + message id, + message id, + ... +); -/*------------*/ -#define glfs_msg_end_x GLFS_MSGID_END, "Invalid: End of messages" - -#endif /* !_component_MESSAGES_H_ */
\ No newline at end of file +#endif /* !_component_MESSAGES_H_ */ |