]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: minor wording improvements to USB FunctionFS documentation
authorLennart Poettering <lennart@poettering.net>
Thu, 1 Oct 2015 12:26:42 +0000 (14:26 +0200)
committerLennart Poettering <lennart@poettering.net>
Thu, 1 Oct 2015 12:26:42 +0000 (14:26 +0200)
man/systemd.service.xml
man/systemd.socket.xml

index eeb98198abf67a53a4d06ef1c5fb0086437ded83..897ea464d90a9ea9a4033603b90134be2f892ecd 100644 (file)
 
       <varlistentry>
         <term><varname>USBFunctionDescriptors=</varname></term>
-        <listitem><para>Configure the location of the file containing
-        <ulink url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">functionfs</ulink>
-        descriptors. This is is used only when a socket with
-        <varname>ListenUSBFunction=</varname> configured wants to
-        activate this service. Content of this file is writen to
-        <filename>ep0</filename> file after it is opened. This is
-        required for socket activation using
-        <varname>ListenUSBFunction=</varname> (i.e. for passing all
-        functionfs endpoints to the service).</para></listitem>
+        <listitem><para>Configure the location of a file containing
+        <ulink
+        url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">USB
+        FunctionFS</ulink> descriptors, for implementation of USB
+        gadget functions. This is is used only in conjunction with a
+        socket unit with <varname>ListenUSBFunction=</varname>
+        configured. The contents of this file is written to the
+        <filename>ep0</filename> file after it is
+        opened.</para></listitem>
       </varlistentry>
 
       <varlistentry>
         <term><varname>USBFunctionStrings=</varname></term>
-        <listitem><para>Configure the location of file containing FunctionFS strings.
-        Behavior is similar to <varname>USBFunctionDescriptors</varname>.</para></listitem>
+        <listitem><para>Configure the location of a file containing
+        USB FunctionFS strings.  Behavior is similar to
+        <varname>USBFunctionDescriptors=</varname>
+        above.</para></listitem>
       </varlistentry>
 
     </variablelist>
index bb75b69cea4d25c65dcf064b157e1bbc3b519156..210bd71913da18d4238910eec2aef347ca24b2f8 100644 (file)
 
       <varlistentry>
         <term><varname>ListenUSBFunction=</varname></term>
-        <listitem><para>Specifies a
-        <ulink url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">functionfs</ulink>
-        endpoint location to
-        listen on. This expects an absolute file system path as the
-        argument. Behavior otherwise is very similar to the
-        <varname>ListenFIFO=</varname> directive above. Use this to
-        open functionfs endpoint <filename>ep0</filename>. When using
-        this option, activated service has to have the
+        <listitem><para>Specifies a <ulink
+        url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">USB
+        FunctionFS</ulink> endpoint location to listen on, for
+        implementation of USB gadget functions. This expects an
+        absolute file system path as the argument. Behavior otherwise
+        is very similar to the <varname>ListenFIFO=</varname>
+        directive above. Use this to open FunctionFS endpoint
+        <filename>ep0</filename>. When using this option, the
+        activated service has to have the
         <varname>USBFunctionDescriptors=</varname> and
         <varname>USBFunctionStrings=</varname> options set.
         </para></listitem>