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 /scripts | |
| 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 'scripts')
| -rwxr-xr-x | scripts/parse_registries.py | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/scripts/parse_registries.py b/scripts/parse_registries.py index 4973633a64..604276ab3c 100755 --- a/scripts/parse_registries.py +++ b/scripts/parse_registries.py @@ -13,11 +13,18 @@ import subprocess import xml.etree.ElementTree as ET -REGISTRY_HEADER = ''' -/**************************************************************** +WARNING = '''/**************************************************************** + * 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. + ***************************************************************/''' + +REGISTRY_HEADER = WARNING + ''' #pragma once #include <registries.hpp> @@ -161,11 +168,9 @@ def make_privilege_registry(): 'privilege_registry.hpp', 'privilege') with open(path, 'w') as registry: registry.write("#pragma once\n") - registry.write( - "// {} is generated. Do not edit directly\n".format( - os.path.basename(path))) + registry.write(WARNING) - registry.write("// clang-format off\n") + registry.write("\n// clang-format off\n") registry.write("\n#include <privileges.hpp>\n\n") registry.write("namespace redfish::privileges\n") registry.write("{\n") |