diff options
| author | Ed Tanous <edtanous@google.com> | 2022-02-17 20:09:25 +0300 |
|---|---|---|
| committer | Ed Tanous <ed@tanous.net> | 2022-03-07 20:52:17 +0300 |
| commit | 1cf53df04bc2525776cf6fd212304c0857cd6a38 (patch) | |
| tree | 1f1c08e23accfadb7f13a92a8f3ea5937cfadb1a /redfish-core/include/registries | |
| parent | 4d99bbb0fdd37fcaa8bebd6a44da1703ea90184e (diff) | |
| download | bmcweb-1cf53df04bc2525776cf6fd212304c0857cd6a38.tar.xz | |
Make generated warning more prominent and helpful
A number of reviews have been submitted that ignore this warning. While
we now have 01caf624211197a993dbbd186149293f7053f9d8 which will catch
these violations at CI time, that is arguably already too late, and
developers will have wasted their time.
This commit changes the warning to be multiple lines, with a caps
header, such that it's less likely to be ignored. It also adds
suggestions on how to proceed.
As a note, this also standardizes privilege registry to use the same
warning as the other files, which it didn't previously.
Tested: Comment changes only, no functional changes.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I3224130dbf581dc962187b2fde4dc98ae26de082
Diffstat (limited to 'redfish-core/include/registries')
4 files changed, 28 insertions, 4 deletions
diff --git a/redfish-core/include/registries/base_message_registry.hpp b/redfish-core/include/registries/base_message_registry.hpp index 6803a8015a..f43f7e708d 100644 --- a/redfish-core/include/registries/base_message_registry.hpp +++ b/redfish-core/include/registries/base_message_registry.hpp @@ -1,7 +1,12 @@ - /**************************************************************** + * READ THIS WARNING FIRST * This is an auto-generated header which contains definitions * for Redfish DMTF defined messages. + * DO NOT modify this registry outside of running the + * parse_regisries.py script. The definitions contained within + * this file are owned by DMTF. Any modifications to these files + * should be first pushed to the relevant registry in the DMTF + * github organization. ***************************************************************/ #pragma once #include <registries.hpp> diff --git a/redfish-core/include/registries/privilege_registry.hpp b/redfish-core/include/registries/privilege_registry.hpp index d2f8fd8dba..bd0a501fb6 100644 --- a/redfish-core/include/registries/privilege_registry.hpp +++ b/redfish-core/include/registries/privilege_registry.hpp @@ -1,5 +1,14 @@ #pragma once -// privilege_registry.hpp is generated. Do not edit directly +/**************************************************************** + * READ THIS WARNING FIRST + * This is an auto-generated header which contains definitions + * for Redfish DMTF defined messages. + * DO NOT modify this registry outside of running the + * parse_regisries.py script. The definitions contained within + * this file are owned by DMTF. Any modifications to these files + * should be first pushed to the relevant registry in the DMTF + * github organization. + ***************************************************************/ // clang-format off #include <privileges.hpp> diff --git a/redfish-core/include/registries/resource_event_message_registry.hpp b/redfish-core/include/registries/resource_event_message_registry.hpp index 4566003b06..f769c77c13 100644 --- a/redfish-core/include/registries/resource_event_message_registry.hpp +++ b/redfish-core/include/registries/resource_event_message_registry.hpp @@ -1,7 +1,12 @@ - /**************************************************************** + * READ THIS WARNING FIRST * This is an auto-generated header which contains definitions * for Redfish DMTF defined messages. + * DO NOT modify this registry outside of running the + * parse_regisries.py script. The definitions contained within + * this file are owned by DMTF. Any modifications to these files + * should be first pushed to the relevant registry in the DMTF + * github organization. ***************************************************************/ #pragma once #include <registries.hpp> diff --git a/redfish-core/include/registries/task_event_message_registry.hpp b/redfish-core/include/registries/task_event_message_registry.hpp index d99d7ce1dc..8f6ec43be1 100644 --- a/redfish-core/include/registries/task_event_message_registry.hpp +++ b/redfish-core/include/registries/task_event_message_registry.hpp @@ -1,7 +1,12 @@ - /**************************************************************** + * READ THIS WARNING FIRST * This is an auto-generated header which contains definitions * for Redfish DMTF defined messages. + * DO NOT modify this registry outside of running the + * parse_regisries.py script. The definitions contained within + * this file are owned by DMTF. Any modifications to these files + * should be first pushed to the relevant registry in the DMTF + * github organization. ***************************************************************/ #pragma once #include <registries.hpp> |