Commit b2433d861eaf349f4dcdc9281e75b139c1809dd3

Authored by Geoff Thorpe
Committed by Greg Kroah-Hartman
1 parent 7b08fae8fb

uio: documentation fixups

The 'name' attribute of struct uio_mem wasn't documented, and the note
about 'kobj' is stale and needs to be changed to 'map'.

Signed-off-by: Geoff Thorpe <geoff@geoffthorpe.net>
Signed-off-by: "Hans J. Koch" <hjk@hansjkoch.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

Showing 1 changed file with 6 additions and 1 deletions Side-by-side Diff

Documentation/DocBook/uio-howto.tmpl
... ... @@ -521,6 +521,11 @@
521 521  
522 522 <itemizedlist>
523 523 <listitem><para>
  524 +<varname>const char *name</varname>: Optional. Set this to help identify
  525 +the memory region, it will show up in the corresponding sysfs node.
  526 +</para></listitem>
  527 +
  528 +<listitem><para>
524 529 <varname>int memtype</varname>: Required if the mapping is used. Set this to
525 530 <varname>UIO_MEM_PHYS</varname> if you you have physical memory on your
526 531 card to be mapped. Use <varname>UIO_MEM_LOGICAL</varname> for logical
... ... @@ -553,7 +558,7 @@
553 558 </itemizedlist>
554 559  
555 560 <para>
556   -Please do not touch the <varname>kobj</varname> element of
  561 +Please do not touch the <varname>map</varname> element of
557 562 <varname>struct uio_mem</varname>! It is used by the UIO framework
558 563 to set up sysfs files for this mapping. Simply leave it alone.
559 564 </para>