From: Miika Karanki <miika.karanki@vaisala.com>
Date: Tue, 23 Nov 2021 15:23:01 +0000 (+0200)
Subject: sd-bus: Fix standard method argument names
X-Git-Tag: v250-rc1~177
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=98503c6d0cae795be89efd74ccab821729c2143a;p=thirdparty%2Fsystemd.git

sd-bus: Fix standard method argument names

The argument names of methods under org.freedesktop.DBus.Properties and
org.freedesktop.DBus.Introspectable interfaces are specifies in D-Bus
specification[1]. They are:

  org.freedesktop.DBus.Introspectable.Introspect (out STRING xml_data)
  org.freedesktop.DBus.Properties.Get (in STRING interface_name,
                                       in STRING property_name,
                                       out VARIANT value);
  org.freedesktop.DBus.Properties.Set (in STRING interface_name,
                                       in STRING property_name,
                                       in VARIANT value);
  org.freedesktop.DBus.Properties.GetAll (in STRING interface_name,
                                          out DICT<STRING,VARIANT> props);

sd-bus is using different argument names in the introspection document.
Usually this is not a problem but in case something tries to map the
argument names based on the introspection document to the position of
the arguments in the method call, then using names different than the
ones specified in the D-Bus specification is confusing.

So fix the names to match the D-Bus specification.

[1] https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-introspectable
---

diff --git a/man/vtable-example.xml b/man/vtable-example.xml
index dc5fac4f267..891b375a4b2 100644
--- a/man/vtable-example.xml
+++ b/man/vtable-example.xml
@@ -10,26 +10,26 @@
  </interface>
  <interface name="org.freedesktop.DBus.Introspectable">
   <method name="Introspect">
-   <arg name="data" type="s" direction="out"/>
+   <arg name="xml_data" type="s" direction="out"/>
   </method>
  </interface>
  <interface name="org.freedesktop.DBus.Properties">
   <method name="Get">
-   <arg name="interface" direction="in" type="s"/>
-   <arg name="property" direction="in" type="s"/>
+   <arg name="interface_name" direction="in" type="s"/>
+   <arg name="property_name" direction="in" type="s"/>
    <arg name="value" direction="out" type="v"/>
   </method>
   <method name="GetAll">
-   <arg name="interface" direction="in" type="s"/>
-   <arg name="properties" direction="out" type="a{sv}"/>
+   <arg name="interface_name" direction="in" type="s"/>
+   <arg name="props" direction="out" type="a{sv}"/>
   </method>
   <method name="Set">
-   <arg name="interface" direction="in" type="s"/>
-   <arg name="property" direction="in" type="s"/>
+   <arg name="interface_name" direction="in" type="s"/>
+   <arg name="property_name" direction="in" type="s"/>
    <arg name="value" direction="in" type="v"/>
   </method>
   <signal name="PropertiesChanged">
-   <arg type="s" name="interface"/>
+   <arg type="s" name="interface_name"/>
    <arg type="a{sv}" name="changed_properties"/>
    <arg type="as" name="invalidated_properties"/>
   </signal>
diff --git a/src/libsystemd/sd-bus/bus-introspect.c b/src/libsystemd/sd-bus/bus-introspect.c
index 866fca7acb8..b9ef6af631c 100644
--- a/src/libsystemd/sd-bus/bus-introspect.c
+++ b/src/libsystemd/sd-bus/bus-introspect.c
@@ -25,28 +25,28 @@
 #define BUS_INTROSPECT_INTERFACE_INTROSPECTABLE                      \
         " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"   \
         "  <method name=\"Introspect\">\n"                              \
-        "   <arg name=\"data\" type=\"s\" direction=\"out\"/>\n"        \
+        "   <arg name=\"xml_data\" type=\"s\" direction=\"out\"/>\n"    \
         "  </method>\n"                                                 \
         " </interface>\n"
 
 #define BUS_INTROSPECT_INTERFACE_PROPERTIES                          \
         " <interface name=\"org.freedesktop.DBus.Properties\">\n"       \
         "  <method name=\"Get\">\n"                                     \
-        "   <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n"    \
-        "   <arg name=\"property\" direction=\"in\" type=\"s\"/>\n"     \
+        "   <arg name=\"interface_name\" direction=\"in\" type=\"s\"/>\n" \
+        "   <arg name=\"property_name\" direction=\"in\" type=\"s\"/>\n" \
         "   <arg name=\"value\" direction=\"out\" type=\"v\"/>\n"       \
         "  </method>\n"                                                 \
         "  <method name=\"GetAll\">\n"                                  \
-        "   <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n"    \
-        "   <arg name=\"properties\" direction=\"out\" type=\"a{sv}\"/>\n" \
+        "   <arg name=\"interface_name\" direction=\"in\" type=\"s\"/>\n" \
+        "   <arg name=\"props\" direction=\"out\" type=\"a{sv}\"/>\n"   \
         "  </method>\n"                                                 \
         "  <method name=\"Set\">\n"                                     \
-        "   <arg name=\"interface\" direction=\"in\" type=\"s\"/>\n"    \
-        "   <arg name=\"property\" direction=\"in\" type=\"s\"/>\n"     \
+        "   <arg name=\"interface_name\" direction=\"in\" type=\"s\"/>\n" \
+        "   <arg name=\"property_name\" direction=\"in\" type=\"s\"/>\n" \
         "   <arg name=\"value\" direction=\"in\" type=\"v\"/>\n"        \
         "  </method>\n"                                                 \
         "  <signal name=\"PropertiesChanged\">\n"                       \
-        "   <arg type=\"s\" name=\"interface\"/>\n"                     \
+        "   <arg type=\"s\" name=\"interface_name\"/>\n"                \
         "   <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"        \
         "   <arg type=\"as\" name=\"invalidated_properties\"/>\n"       \
         "  </signal>\n"                                                 \