Add searchable macros
Now that we consistently match our options to our macros, we can add
some comments into the meson.options to make it so that when that macro
is searched, it will pop up correctly.
Tested: No functional change.
Change-Id: I0cf26cac084b845229b9e39993fbc566a3bb6532
Signed-off-by: Ed Tanous <etanous@nvidia.com>
diff --git a/meson.options b/meson.options
index b80a666..4dbe2f3 100644
--- a/meson.options
+++ b/meson.options
@@ -1,3 +1,4 @@
+# BMCWEB_KVM
option(
'kvm',
type: 'feature',
@@ -6,6 +7,7 @@
Video is from the BMCs /dev/videodevice.''',
)
+# BMCWEB_TESTS
option(
'tests',
type: 'feature',
@@ -13,6 +15,7 @@
description: 'Enable Unit tests for bmcweb',
)
+# BMCWEB_VM_WEBSOCKET
option(
'vm-websocket',
type: 'feature',
@@ -22,6 +25,7 @@
https://github.com/openbmc/jsnbd/blob/master/README.''',
)
+# BMCWEB_NBDPROXY
# if you use this option and are seeing this comment, please comment here:
# https://github.com/openbmc/bmcweb/issues/188 and put forward your intentions
# for this code. At this point, no daemon has been upstreamed that implements
@@ -35,6 +39,7 @@
# description: 'Enable the Virtual Media WebSocket.'
#)
+# BMCWEB_REST
option(
'rest',
type: 'feature',
@@ -45,6 +50,7 @@
https://github.com/openbmc/docs/blob/master/rest-api.md.''',
)
+# BMCWEB_REDFISH
option(
'redfish',
type: 'feature',
@@ -53,6 +59,7 @@
https://github.com/openbmc/bmcweb/blob/master/DEVELOPING.md#redfish.''',
)
+# BMCWEB_HOST_SERIAL_SOCKET
option(
'host-serial-socket',
type: 'feature',
@@ -61,6 +68,7 @@
See https://github.com/openbmc/docs/blob/master/console.md.''',
)
+# BMCWEB_STATIC_HOSTING
option(
'static-hosting',
type: 'feature',
@@ -69,6 +77,7 @@
as paths under /.''',
)
+# BMCWEB_REDFISH_BMC_JOURNAL
option(
'redfish-bmc-journal',
type: 'feature',
@@ -77,6 +86,7 @@
/redfish/v1/Managers/bmc/LogServices/Journal.''',
)
+# BMCWEB_REDFISH_CPU_LOG
option(
'redfish-cpu-log',
type: 'feature',
@@ -85,6 +95,7 @@
are under /redfish/v1/Systems/system/LogServices/Crashdump'.''',
)
+# BMCWEB_REDFISH_DUMP_LOG
option(
'redfish-dump-log',
type: 'feature',
@@ -94,6 +105,7 @@
and /redfish/v1/Managers/bmc/LogServices/Dump''',
)
+# BMCWEB_REDFISH_DBUS_LOG
option(
'redfish-dbus-log',
type: 'feature',
@@ -103,6 +115,7 @@
/redfish/v1/Systems/system/LogServices/EventLog/Entries''',
)
+# BMCWEB_REDFISH_HOST_LOGGER
option(
'redfish-host-logger',
type: 'feature',
@@ -112,6 +125,7 @@
/redfish/v1/Systems/system/LogServices/HostLogger''',
)
+# BMCWEB_REDFISH_PROVISIONING_FEATURE
option(
'redfish-provisioning-feature',
type: 'feature',
@@ -120,6 +134,7 @@
under /redfish/v1/Systems/system/''',
)
+# BMCWEB_REDFISH_MANAGER_URI_NAME
option(
'redfish-manager-uri-name',
type: 'string',
@@ -131,6 +146,7 @@
/redfish/v1/Managers/bmc''',
)
+# BMCWEB_REDFISH_SYSTEM_URI_NAME
option(
'redfish-system-uri-name',
type: 'string',
@@ -142,6 +158,7 @@
/redfish/v1/Systems/system''',
)
+# BMCWEB_LOGGING_LEVEL
option(
'bmcweb-logging',
type: 'combo',
@@ -161,6 +178,7 @@
- For the other logging level option, see DEVELOPING.md.''',
)
+# BMCWEB_BASIC_AUTH
option(
'basic-auth',
type: 'feature',
@@ -168,6 +186,7 @@
description: 'Enable basic authentication',
)
+# BMCWEB_SESSION_AUTH
option(
'session-auth',
type: 'feature',
@@ -175,6 +194,7 @@
description: 'Enable session authentication',
)
+# BMCWEB_XTOKEN_AUTH
option(
'xtoken-auth',
type: 'feature',
@@ -182,6 +202,7 @@
description: 'Enable xtoken authentication',
)
+# BMCWEB_COOKIE_AUTH
option(
'cookie-auth',
type: 'feature',
@@ -189,6 +210,7 @@
description: 'Enable cookie authentication',
)
+# BMCWEB_MUTUAL_TLS_AUTH
option(
'mutual-tls-auth',
type: 'feature',
@@ -198,6 +220,7 @@
this option to take effect.''',
)
+# BMCWEB_MUTUAL_TLS_COMMON_NAME_PARSING_DEFAULT
option(
'mutual-tls-common-name-parsing-default',
type: 'combo',
@@ -208,6 +231,7 @@
''',
)
+# BMCWEB_META_TLS_COMMON_NAME_PARSING
option(
'meta-tls-common-name-parsing',
type: 'feature',
@@ -217,6 +241,7 @@
''',
)
+# BMCWEB_IBM_MANAGEMENT_CONSOLE
option(
'ibm-management-console',
type: 'feature',
@@ -225,6 +250,7 @@
Paths are under /ibm/v1/''',
)
+# BMCWEB_GOOGLE_API
option(
'google-api',
type: 'feature',
@@ -233,6 +259,7 @@
/google/v1/''',
)
+# BMCWEB_HTTP_BODY_LIMIT
option(
'http-body-limit',
type: 'integer',
@@ -242,6 +269,7 @@
description: 'Specifies the http request body length limit',
)
+# BMCWEB_REDFISH_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
option(
'redfish-new-powersubsystem-thermalsubsystem',
type: 'feature',
@@ -251,6 +279,7 @@
sensors in the SensorCollection.''',
)
+# BMCWEB_REDFISH_ALLOW_DEPRECATED_POWER_THERMAL
option(
'redfish-allow-deprecated-power-thermal',
type: 'feature',
@@ -260,6 +289,7 @@
will be disabled by default June 2024. ''',
)
+# BMCWEB_REDFISH_OEM_MANAGER_FAN_DATA
option(
'redfish-oem-manager-fan-data',
type: 'feature',
@@ -269,6 +299,7 @@
OpenBMCManager schema for more detail.''',
)
+# BMCWEB_REDFISH_UPDATESERVICE_USE_DBUS
option(
'redfish-updateservice-use-dbus',
type: 'feature',
@@ -283,6 +314,7 @@
''',
)
+# BMCWEB_HTTPS_PORT
option(
'https_port',
type: 'integer',
@@ -292,6 +324,7 @@
description: 'HTTPS Port number.',
)
+# BMCWEB_DNS_RESOLVER
option(
'dns-resolver',
type: 'combo',
@@ -303,6 +336,7 @@
names when boost threading is disabled.''',
)
+# BMCWEB_REDFISH_AGGREGATION
option(
'redfish-aggregation',
type: 'feature',
@@ -310,6 +344,7 @@
description: 'Allows this BMC to aggregate resources from satellite BMCs',
)
+# BMCWEB_HYPERVISOR_COMPUTER_SYSTEM
option(
'hypervisor-computer-system',
type: 'feature',
@@ -319,6 +354,7 @@
resources such as EthernetInterfaces and ComputerSystem.Reset.''',
)
+# BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM
option(
'experimental-redfish-multi-computer-system',
type: 'feature',
@@ -329,6 +365,7 @@
production environment, or where API stability is required.''',
)
+# BMCWEB_EXPERIMENTAL_HTTP2
option(
'experimental-http2',
type: 'feature',
@@ -343,6 +380,7 @@
# the implications of doing so.In general, enabling these options will cause security
# problems of varying degrees
+# BMCWEB_INSECURE_DISABLE_CSRF
option(
'insecure-disable-csrf',
type: 'feature',
@@ -351,6 +389,7 @@
production systems.''',
)
+# BMCWEB_INSECURE_DISABLE_SSL
option(
'insecure-disable-ssl',
type: 'feature',
@@ -359,6 +398,7 @@
systems.''',
)
+# BMCWEB_INSECURE_DISABLE_AUTH
option(
'insecure-disable-auth',
type: 'feature',
@@ -367,6 +407,7 @@
Should be set to false for production systems.''',
)
+# BMCWEB_INSECURE_IGNORE_CONTENT_TYPE
option(
'insecure-ignore-content-type',
type: 'feature',
@@ -378,6 +419,7 @@
Content-Type header on payloads.''',
)
+# BMCWEB_INSECURE_PUSH_STYLE_NOTIFICATION
option(
'insecure-push-style-notification',
type: 'feature',
@@ -385,6 +427,7 @@
description: 'Enable HTTP push style eventing feature',
)
+# BMCWEB_INSECURE_ENABLE_REDFISH_QUERY
option(
'insecure-enable-redfish-query',
type: 'feature',