diff options
| author | Lennart Poettering <lennart@poettering.net> | 2015-10-01 14:26:42 +0200 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2015-10-01 14:26:42 +0200 |
| commit | 3d3145100d77a059b145a488df3d31763fdf1920 (patch) | |
| tree | da3e94dcd4e09bea1ebb610cc807daa8f762167d | |
| parent | d4e783e44dccb3d5e7ea2fd42b107b2c3e44629b (diff) | |
man: minor wording improvements to USB FunctionFS documentation
| -rw-r--r-- | man/systemd.service.xml | 24 | ||||
| -rw-r--r-- | man/systemd.socket.xml | 17 |
2 files changed, 22 insertions, 19 deletions
diff --git a/man/systemd.service.xml b/man/systemd.service.xml index eeb98198ab..897ea464d9 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -905,21 +905,23 @@ <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> diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index bb75b69cea..210bd71913 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -262,14 +262,15 @@ <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> |