conf: fixup config comments

Use () to mark optional fields to avoid confusion with [] for arrays.
Add contition fields where available.
This commit is contained in:
Wim Taymans 2023-02-07 10:35:43 +01:00
parent 5552ff7fdd
commit fda829a1fa
7 changed files with 28 additions and 16 deletions

View file

@ -60,8 +60,9 @@ context.spa-libs = {
context.modules = [
#{ name = <module-name>
# [ args = { <key> = <value> ... } ]
# [ flags = [ [ ifexists ] [ nofail ] ]
# ( args = { <key> = <value> ... } )
# ( flags = [ ( ifexists ) ( nofail ) ] )
# ( condition = [ { <key> = <value> ... } ... ] )
#}
#
# Loads a module with the given parameters.
@ -135,8 +136,9 @@ context.modules = [
context.objects = [
#{ factory = <factory-name>
# [ args = { <key> = <value> ... } ]
# [ flags = [ [ nofail ] ]
# ( args = { <key> = <value> ... } )
# ( flags = [ ( nofail ) ] )
# ( condition = [ { <key> = <value> ... } ... ] )
#}
#
# Creates an object from a PipeWire factory with the given parameters.
@ -339,7 +341,10 @@ context.objects = [
]
context.exec = [
#{ path = <program-name> [ args = "<arguments>" ] }
#{ path = <program-name>
# ( args = "<arguments>" )
# ( condition = [ { <key> = <value> ... } ... ] )
#}
#
# Execute the given program with arguments.
#