diff options
| author | Joseph Reynolds <jrey@us.ibm.com> | 2018-11-07 22:01:31 -0600 |
|---|---|---|
| committer | Ed Tanous <ed.tanous@intel.com> | 2018-12-10 21:17:26 +0000 |
| commit | 7a777f58cbff69997a1b8fc85dc8caebcd2e4964 (patch) | |
| tree | 769ebcf5aed6fe9e6294dbf8d4ff3b1d7f8b1aaa | |
| parent | 1b6b96c570fdf7ca5c643f3d0776581656e78070 (diff) | |
| download | bmcweb-7a777f58cbff69997a1b8fc85dc8caebcd2e4964.tar.gz bmcweb-7a777f58cbff69997a1b8fc85dc8caebcd2e4964.zip | |
Add details to BMCWEB config option help strings
Added URL paths and links to option documentation.
Fixed spelling error.
Tested: compiles
Change-Id: I25c2a2756e46843a19425163bca0d99011423ce2
Signed-off-by: Joseph Reynolds <jrey@us.ibm.com>
| -rw-r--r-- | CMakeLists.txt | 47 |
1 files changed, 26 insertions, 21 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index c6d20c6..2bd8a71 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -5,28 +5,33 @@ cmake_policy (SET CMP0054 NEW) set (CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH}) option (BUILD_STATIC_LIBS "Built static libraries" ON) -option (YOCTO_DEPENDENCIES "Use YOCTO depedencies system" OFF) - -option (BMCWEB_ENABLE_KVM "Enable KVM websocket interfaces" ON) -option (BMCWEB_ENABLE_DBUS_REST "Enable rest dbus interfaces" ON) -option (BMCWEB_ENABLE_REDFISH "Enable redfish interfaces" ON) -option (BMCWEB_ENABLE_HOST_SERIAL_WEBSOCKET "Enable host serial websocket" ON) -option (BMCWEB_ENABLE_STATIC_HOSTING "Enable hosting of static files. - For example, redfish schema and webui files" ON) - -option ( - BMCWEB_ENABLE_REDFISH_BMC_JOURNAL - "Enable BMC journal access through redfish" OFF -) -option ( - BMCWEB_ENABLE_REDFISH_RAW_PECI "Enable PECI transactions through redfish" - OFF -) -option ( - BMCWEB_ENABLE_REDFISH_CPU_LOG - "Enable CPU log service transactions through redfish" OFF -) +option (YOCTO_DEPENDENCIES "Use YOCTO dependencies system" OFF) + +option (BMCWEB_ENABLE_KVM "Enable the KVM host video WebSocket. Path is + '/kvmws'. Video is from the BMC's '/dev/video' device." ON) +option (BMCWEB_ENABLE_DBUS_REST "Enable Phosphor REST (D-Bus) APIs. Paths + directly map Phosphor D-Bus object paths, for example, + '/xyz/openbmc_project/logging/entry/enumerate'. See + https://github.com/openbmc/docs/blob/master/rest-api.md." ON) +option (BMCWEB_ENABLE_REDFISH "Enable Redfish APIs. Paths are under + '/redfish/v1/'. See + https://github.com/openbmc/bmcweb/blob/master/DEVELOPING.md#redfish." + ON) +option (BMCWEB_ENABLE_HOST_SERIAL_WEBSOCKET "Enable host serial console + WebSocket. Path is '/console0'. See + https://github.com/openbmc/docs/blob/master/console.md." ON) +option (BMCWEB_ENABLE_STATIC_HOSTING "Enable serving files from the + '/usr/share/www' directory as paths under '/'." ON) +option (BMCWEB_ENABLE_REDFISH_BMC_JOURNAL "Enable BMC journal access through + Redfish. Paths are under + '/redfish/v1/Managers/bmc/LogServices/Journal'." OFF) +option (BMCWEB_ENABLE_REDFISH_RAW_PECI "Enable PECI transactions through + Redfish. Paths are under '/redfish/v1/Managers/bmc/LogServices/CpuLog/ + Actions/Oem/CpuLog.SendRawPeci'." OFF) +option (BMCWEB_ENABLE_REDFISH_CPU_LOG "Enable CPU log service transactions + through Redfish. Paths are under + '/redfish/v1/Managers/bmc/LogServices/CpuLog'." OFF) # Insecure options. Every option that starts with a BMCWEB_INSECURE flag should # not be enabled by default for any platform, unless the author fully |
