diff options
author | Xavier Hernandez <jahernan@redhat.com> | 2017-12-12 22:31:53 +0100 |
---|---|---|
committer | Amar Tumballi <amarts@redhat.com> | 2017-12-14 02:33:51 +0000 |
commit | 415e0bcc80b350fc75f325b490560f44ba419b20 (patch) | |
tree | 6b428127e3fb460da434e7eab18352c65898eb9b /xlators/features/selinux | |
parent | bafe0c14f5743cb084a89595860e4ba33baf900c (diff) |
all: Simplify component message id's definition
This patch creates a new way of defining message id's that is easier
and less error prone because it doesn't require so many manual changes
each time a new component is defined or a new message created.
Change-Id: I71ba8af9ac068f5add7e74f316a2478bc991c67b
Signed-off-by: Xavier Hernandez <jahernan@redhat.com>
Diffstat (limited to 'xlators/features/selinux')
-rw-r--r-- | xlators/features/selinux/src/selinux-messages.h | 89 |
1 files changed, 13 insertions, 76 deletions
diff --git a/xlators/features/selinux/src/selinux-messages.h b/xlators/features/selinux/src/selinux-messages.h index a498dc21471..3a1663433ab 100644 --- a/xlators/features/selinux/src/selinux-messages.h +++ b/xlators/features/selinux/src/selinux-messages.h @@ -13,86 +13,23 @@ #include "glfs-message-id.h" -/*! \file selinux-messages.h - * \brief Selinux log-message IDs and their descriptions - */ - -/* 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 readability 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. - */ - -#define GLFS_SL_BASE GLFS_MSGID_COMP_SL -#define GLFS_SL_NUM_MESSAGES 5 -#define GLFS_SL_MSGID_END (GLFS_SL_BASE + GLFS_NUM_MESSAGES + 1) -/* Messages with message IDs */ -#define glfs_msg_start_x GLFS_SL_BASE, "Invalid: Start of messages" -/*------------*/ - -#define SL_MSG_INVALID_VOLFILE (GLFS_SL_BASE + 1) - -/*! - * @messageid - * @diagnosis - * @recommendedaction +/* To add new message IDs, append new identifiers at the end of the list. * - */ - -#define SL_MSG_ENOMEM (GLFS_SL_BASE + 2) - -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ - -#define SL_MSG_MEM_ACCT_INIT_FAILED (GLFS_SL_BASE + 3) - -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ - -#define SL_MSG_SELINUX_GLUSTER_XATTR_MISSING (GLFS_SL_BASE + 4) - -/*! - * @messageid - * @diagnosis - * @recommendedaction - * - */ - -#define SL_MSG_SELINUX_XATTR_MISSING (GLFS_SL_BASE + 5) - -/*! - * @messageid - * @diagnosis - * @recommendedaction + * 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_msg_end_x GLFS_MSGID_END, "Invalid: End of messages" +GLFS_MSGID(SL, + SL_MSG_INVALID_VOLFILE, + SL_MSG_ENOMEM, + SL_MSG_MEM_ACCT_INIT_FAILED, + SL_MSG_SELINUX_GLUSTER_XATTR_MISSING, + SL_MSG_SELINUX_XATTR_MISSING +); #endif /*_SELINUX_MESSAGES_H */ |