Fix spacings in meson_options
The meson_options.txt looks to be very cumbersome and is difficult to
read & maintain due to in-consistent white spacing, and the lines are
longer than 80 characters.
This commit would fix those by migrating the syntax to new lines for
each option key, also warps the comments and the description to
80 characters & uses multilines for descriptions that are larger than 80
characters.Doing this should make this file more maintainable in future.
Change-Id: Ic8421cc21b8809c659be8e63b02b6877542a47fd
Signed-off-by: Manojkiran Eda <manojkiran.eda@gmail.com>
diff --git a/meson_options.txt b/meson_options.txt
index 9cff3fd..2ea557d 100644
--- a/meson_options.txt
+++ b/meson_options.txt
@@ -1,30 +1,163 @@
-option('tests', type: 'feature', description: 'Build tests', value: 'enabled')
-option('oe-sdk', type: 'feature', description: 'Enable OE SDK')
-option('oem-ibm', type: 'feature', description: 'Enable IBM OEM PLDM', value: 'enabled')
-option('utilities', type: 'feature', description: 'Enable debug utilities', value: 'enabled')
-option('libpldmresponder', type: 'feature', description: 'Enable libpldmresponder', value: 'enabled')
+# PLDM daemon options
+option(
+ 'tests',
+ type: 'feature',
+ value: 'enabled',
+ description: 'Build tests'
+)
-option('oem-ibm-dma-maxsize', type: 'integer', min:4096, max: 16773120, description: 'OEM-IBM: max DMA size', value: 8384512) #16MB - 4K
-option('softoff', type: 'feature', description: 'Build soft power off application', value: 'enabled')
-option('softoff-timeout-seconds', type: 'integer', description: 'softoff: Time to wait for host to gracefully shutdown', value: 7200)
+option(
+ 'oe-sdk',
+ type: 'feature',
+ description: 'Enable OE SDK'
+)
-option('systemd', type: 'feature', description: 'Include systemd support', value: 'enabled')
+option(
+ 'utilities',
+ type: 'feature',
+ value: 'enabled',
+ description: 'Enable debug utilities'
+)
-# Timing specifications for PLDM messages
-option('number-of-request-retries', type: 'integer', min: 2, max: 30, description: 'The number of times a requester is obligated to retry a request', value: 2)
-option('instance-id-expiration-interval', type: 'integer', min: 5, max: 6, description: 'Instance ID expiration interval in seconds', value: 5)
-# Default response-time-out set to 2 seconds to facilitate a minimum retry of the request of 2.
-option('response-time-out', type: 'integer', min: 300, max: 4800, description: 'The amount of time a requester has to wait for a response message in milliseconds', value: 2000)
-# Time taken to wait for the reply for any PLDM dbus call is set to 5 seconds. After 5 seconds the dbus method will exit.
-option('dbus-timeout-value', type: 'integer', min: 3, max: 10, description: 'The amount of time pldm waits to get a response for a dbus message before timing out', value: 5)
+option(
+ 'libpldmresponder',
+ type: 'feature',
+ value: 'enabled',
+ description: 'Enable libpldmresponder'
+)
-option('heartbeat-timeout-seconds', type: 'integer', description: ' The amount of time host waits for BMC to respond to pings from host, as part of host-bmc surveillance', value: 120)
+option(
+ 'systemd',
+ type: 'feature',
+ value: 'enabled',
+ description: 'Include systemd support'
+)
-# PLDM Terminus options
-option('terminus-id', type:'integer', min:0, max: 255, description: 'The terminus id value of the device that is running this pldm stack', value:1)
-option('terminus-handle',type:'integer',min:0, max:65535, description: 'The terminus handle value of the device that is running this pldm stack', value:1)
+# Time taken to wait for the reply for any PLDM dbus call is set to 5 seconds.
+# After 5 seconds the dbus method will exit.
+option(
+ 'dbus-timeout-value',
+ type: 'integer',
+ min: 3,
+ max: 10,
+ value: 5,
+ description: '''The amount of time pldm waits to get a response for a dbus
+ message before timing out'''
+)
+
+option(
+ 'heartbeat-timeout-seconds',
+ type: 'integer',
+ value: 120,
+ description: '''The amount of time host waits for BMC to respond to pings
+ from host, as part of host-bmc surveillance'''
+)
+
+# Flight Recorder for PLDM Daemon
+option(
+ 'flightrecorder-max-entries',
+ type:'integer',
+ min:0,
+ max:30,
+ value: 10,
+ description: '''The max number of pldm messages that can be stored in the
+ recorder, this feature will be disabled if it is set to 0'''
+)
+
+# PLDM Daemon Terminus options
+option(
+ 'terminus-id',
+ type:'integer',
+ min:0,
+ max: 255,
+ value:1,
+ description: '''The terminus id value of the device that is running this
+ pldm stack'''
+)
+
+option(
+ 'terminus-handle',
+ type:'integer',
+ min:0,
+ max:65535,
+ value:1,
+ description: '''The terminus handle value of the device that is running this
+ pldm stack'''
+)
+
+# Timing specification options for PLDM messages
+option(
+ 'number-of-request-retries',
+ type: 'integer',
+ min: 2,
+ max: 30,
+ value: 2,
+ description: '''The number of times a requester is obligated to retry a
+ request'''
+)
+
+option(
+ 'instance-id-expiration-interval',
+ type: 'integer',
+ min: 5,
+ max: 6,
+ value: 5,
+ description: 'Instance ID expiration interval in seconds'
+)
+
+# Default response-time-out set to 2 seconds to facilitate a minimum retry of
+# the request of 2.
+option(
+ 'response-time-out',
+ type: 'integer',
+ min: 300,
+ max: 4800,
+ value: 2000,
+ description: '''The amount of time a requester has to wait for a response
+ message in milliseconds'''
+)
# Firmware update configuration parameters
-option('maximum-transfer-size', type: 'integer', min: 16, max: 4294967295, description: 'Maximum size in bytes of the variable payload allowed to be requested by the FD, via RequestFirmwareData command', value: 4096)
-# Flight Recorder for PLDM Daemon
-option('flightrecorder-max-entries', type:'integer',min:0, max:30, description: 'The max number of pldm messages that can be stored in the recorder, this feature will be disabled if it is set to 0', value: 10)
+option(
+ 'maximum-transfer-size',
+ type: 'integer',
+ min: 16,
+ max: 4294967295,
+ value: 4096,
+ description: '''Maximum size in bytes of the variable payload allowed to be
+ requested by the FD, via RequestFirmwareData command'''
+)
+
+# PLDM Soft Power off options
+option(
+ 'softoff',
+ type: 'feature',
+ value: 'enabled',
+ description: 'Build soft power off application'
+)
+
+option(
+ 'softoff-timeout-seconds',
+ type: 'integer',
+ value: 7200,
+ description: 'softoff: Time to wait for host to gracefully shutdown'
+)
+
+# Vendor Specific Options
+
+## OEM IBM Options
+option(
+ 'oem-ibm',
+ type: 'feature',
+ value: 'enabled',
+ description: 'Enable IBM OEM PLDM'
+)
+
+option(
+ 'oem-ibm-dma-maxsize',
+ type: 'integer',
+ min:4096,
+ max: 16773120,
+ value: 8384512,
+ description: 'OEM-IBM: max DMA size'
+)