From 07e6f44e588cefcc70aa4d48eebef81a963291d8 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Wed, 22 Mar 2023 16:35:55 +0100 Subject: [PATCH] modules: clean up USAGE arguments use () to mark optional arguments to avoid confusion with arrays. Add some more optional arguments. --- src/modules/module-access.c | 8 +++--- src/modules/module-adapter.c | 2 +- src/modules/module-combine-stream.c | 18 +++++++------- src/modules/module-echo-cancel.c | 26 ++++++++++---------- src/modules/module-example-sink.c | 16 ++++++------ src/modules/module-example-source.c | 16 ++++++------ src/modules/module-fallback-sink.c | 4 +-- src/modules/module-filter-chain.c | 26 +++++++++++--------- src/modules/module-link-factory.c | 12 ++++----- src/modules/module-loopback.c | 18 +++++++------- src/modules/module-pipe-tunnel.c | 24 +++++++++--------- src/modules/module-protocol-simple.c | 26 ++++++++++---------- src/modules/module-pulse-tunnel.c | 24 +++++++++--------- src/modules/module-raop-discover.c | 2 +- src/modules/module-raop-sink.c | 32 ++++++++++++------------ src/modules/module-roc-sink.c | 12 ++++----- src/modules/module-roc-source.c | 16 ++++++------ src/modules/module-rt.c | 8 +++--- src/modules/module-rtp-sap.c | 16 ++++++------ src/modules/module-rtp-session.c | 30 +++++++++++------------ src/modules/module-rtp-sink.c | 34 +++++++++++++------------- src/modules/module-rtp-source.c | 20 +++++++-------- src/modules/module-x11-bell.c | 8 +++--- src/modules/module-zeroconf-discover.c | 2 +- 24 files changed, 200 insertions(+), 200 deletions(-) diff --git a/src/modules/module-access.c b/src/modules/module-access.c index 224d60435..9948d3953 100644 --- a/src/modules/module-access.c +++ b/src/modules/module-access.c @@ -111,10 +111,10 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME); #define PW_LOG_TOPIC_DEFAULT mod_topic -#define MODULE_USAGE "[ access.force=flatpak ] " \ - "[ access.allowed= ] " \ - "[ access.rejected= ] " \ - "[ access.restricted= ] " \ +#define MODULE_USAGE "( access.force=flatpak ) " \ + "( access.allowed= [ ,.. ] ) " \ + "( access.rejected= [ ,.. ] ) " \ + "( access.restricted= [ ,.. ] ) " \ static const struct spa_dict_item module_props[] = { { PW_KEY_MODULE_AUTHOR, "Wim Taymans " }, diff --git a/src/modules/module-adapter.c b/src/modules/module-adapter.c index 75cc08930..2c26dd3f0 100644 --- a/src/modules/module-adapter.c +++ b/src/modules/module-adapter.c @@ -26,7 +26,7 @@ PW_LOG_TOPIC(mod_topic, "mod." NAME); #define PW_LOG_TOPIC_DEFAULT mod_topic #define FACTORY_USAGE SPA_KEY_FACTORY_NAME"= " \ - "["SPA_KEY_LIBRARY_NAME"=] " \ + "("SPA_KEY_LIBRARY_NAME"=) " \ ADAPTER_USAGE static const struct spa_dict_item module_props[] = { diff --git a/src/modules/module-combine-stream.c b/src/modules/module-combine-stream.c index 73aa8c420..0dc10f0d8 100644 --- a/src/modules/module-combine-stream.c +++ b/src/modules/module-combine-stream.c @@ -198,15 +198,15 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME); #define DEFAULT_CHANNELS 2 #define DEFAULT_POSITION "[ FL FR ]" -#define MODULE_USAGE "[ node.latency= ] " \ - "[ combine.mode=, default:sink ] " \ - "[ node.name= ] " \ - "[ node.description= ] " \ - "[ audio.channels= ] " \ - "[ audio.position= ] " \ - "[ combine.props= ] " \ - "[ stream.props= ] " \ - "[ stream.rules= ] " +#define MODULE_USAGE "( node.latency= ) " \ + "( combine.mode=, default:sink ) " \ + "( node.name= ) " \ + "( node.description= ) " \ + "( audio.channels= ) " \ + "( audio.position= ) " \ + "( combine.props= ) " \ + "( stream.props= ) " \ + "( stream.rules= ) " static const struct spa_dict_item module_props[] = { diff --git a/src/modules/module-echo-cancel.c b/src/modules/module-echo-cancel.c index b0db1cc04..0cdcf5e56 100644 --- a/src/modules/module-echo-cancel.c +++ b/src/modules/module-echo-cancel.c @@ -157,19 +157,19 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME); static const struct spa_dict_item module_props[] = { { PW_KEY_MODULE_AUTHOR, "Wim Taymans " }, { PW_KEY_MODULE_DESCRIPTION, "Echo Cancellation" }, - { PW_KEY_MODULE_USAGE, " [ remote.name= ] " - "[ node.latency= ] " - "[ audio.rate= ] " - "[ audio.channels= ] " - "[ audio.position= ] " - "[ buffer.max_size= ] " - "[ buffer.play_delay= ] " - "[ library.name = ] " - "[ aec.args= ] " - "[ capture.props= ] " - "[ source.props= ] " - "[ sink.props= ] " - "[ playback.props= ] " }, + { PW_KEY_MODULE_USAGE, " ( remote.name= ) " + "( node.latency= ) " + "( audio.rate= ) " + "( audio.channels= ) " + "( audio.position= ) " + "( buffer.max_size= ) " + "( buffer.play_delay= ) " + "( library.name = ) " + "( aec.args= ) " + "( capture.props= ) " + "( source.props= ) " + "( sink.props= ) " + "( playback.props= ) " }, { PW_KEY_MODULE_VERSION, PACKAGE_VERSION }, }; diff --git a/src/modules/module-example-sink.c b/src/modules/module-example-sink.c index a14ee6ff5..7413933c3 100644 --- a/src/modules/module-example-sink.c +++ b/src/modules/module-example-sink.c @@ -83,14 +83,14 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME); #define DEFAULT_CHANNELS 2 #define DEFAULT_POSITION "[ FL FR ]" -#define MODULE_USAGE "[ node.latency= ] " \ - "[ node.name= ] " \ - "[ node.description= ] " \ - "[ audio.format= ] " \ - "[ audio.rate= ] " \ - "[ audio.channels= ] " \ - "[ audio.position= ] " \ - "[ stream.props= ] " +#define MODULE_USAGE "( node.latency= ) " \ + "( node.name= ) " \ + "( node.description= ) " \ + "( audio.format= ) " \ + "( audio.rate= ) " \ + "( audio.channels= ) " \ + "( audio.position= ] " \ + "( stream.props= ) " static const struct spa_dict_item module_props[] = { diff --git a/src/modules/module-example-source.c b/src/modules/module-example-source.c index 635f4af03..e6be6717e 100644 --- a/src/modules/module-example-source.c +++ b/src/modules/module-example-source.c @@ -83,14 +83,14 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME); #define DEFAULT_CHANNELS 2 #define DEFAULT_POSITION "[ FL FR ]" -#define MODULE_USAGE "[ node.latency= ] " \ - "[ node.name= ] " \ - "[ node.description= ] " \ - "[ audio.format= ] " \ - "[ audio.rate= ] " \ - "[ audio.channels= ] " \ - "[ audio.position= ] " \ - "[ stream.props= ] " +#define MODULE_USAGE "( node.latency= ) " \ + "( node.name= ) " \ + "( node.description= ) " \ + "( audio.format= ) " \ + "( audio.rate= ) " \ + "( audio.channels= ) " \ + "( audio.position= ) " \ + "( stream.props= ) " static const struct spa_dict_item module_props[] = { diff --git a/src/modules/module-fallback-sink.c b/src/modules/module-fallback-sink.c index 4474fc124..17f0f505c 100644 --- a/src/modules/module-fallback-sink.c +++ b/src/modules/module-fallback-sink.c @@ -33,8 +33,8 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME); #define PW_LOG_TOPIC_DEFAULT mod_topic -#define MODULE_USAGE ("[ sink.name= ] " \ - "[ sink.description= ] ") +#define MODULE_USAGE ("( sink.name= ) " \ + "( sink.description= ) ") static const struct spa_dict_item module_props[] = { { PW_KEY_MODULE_AUTHOR, "Pauli Virtanen " }, diff --git a/src/modules/module-filter-chain.c b/src/modules/module-filter-chain.c index 784896523..7073baa4b 100644 --- a/src/modules/module-filter-chain.c +++ b/src/modules/module-filter-chain.c @@ -62,7 +62,7 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME); * filter.graph = { * nodes = [ * { - * type = + * type = * name = * plugin = * label =