[PATCH] uio: documentation fixups

[PATCH] uio: documentation fixups

[Geoff Thorpe]

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>
---

 I was hacking on some UIO-related code and noticed some minor
 glitches in the howto. Just sending it along to get it "off my desk",
 but please feel free to squash this into any other fixes/updates that
 may be pending.

 Regards,
 Geoff

 Documentation/DocBook/uio-howto.tmpl |    7 ++++++-
 1 files changed, 6 insertions(+), 1 deletions(-)

diff --git a/Documentation/DocBook/uio-howto.tmpl b/Documentation/DocBook/uio-howto.tmpl
index bc4a709..8e98e2f 100644
--- a/Documentation/DocBook/uio-howto.tmpl
+++ b/Documentation/DocBook/uio-howto.tmpl
@@ -533,6 +533,11 @@ Here's a description of the fields of <varname>struct uio_mem</varname>:
 
 <itemizedlist>
 <listitem><para>
+<varname>const char *name</varname>: Optional. Set this to help identify
+the memory region, it will show up in the corresponding sysfs node.
+</para></listitem>
+
+<listitem><para>
 <varname>int memtype</varname>: Required if the mapping is used. Set this to
 <varname>UIO_MEM_PHYS</varname> if you you have physical memory on your
 card to be mapped. Use <varname>UIO_MEM_LOGICAL</varname> for logical
@@ -565,7 +570,7 @@ instead to remember such an address.
 </itemizedlist>
 
 <para>
-Please do not touch the <varname>kobj</varname> element of
+Please do not touch the <varname>map</varname> element of
 <varname>struct uio_mem</varname>! It is used by the UIO framework
 to set up sysfs files for this mapping. Simply leave it alone.
 </para>
-- 
1.7.3.4

Re: [PATCH] uio: documentation fixups

[Hans J. Koch]

On Wed, Nov 02, 2011 at 11:44:44AM -0400, Geoff Thorpe wrote:
> The 'name' attribute of struct uio_mem wasn't documented, and the note
> about 'kobj' is stale and needs to be changed to 'map'.

Great, thanks for sending a patch instead of just ignoring it.

> 
> Signed-off-by: Geoff Thorpe <geoff@geoffthorpe.net>

Signed-off-by: "Hans J. Koch" <hjk@hansjkoch.de>

> ---
> 
>  I was hacking on some UIO-related code and noticed some minor
>  glitches in the howto. Just sending it along to get it "off my desk",
>  but please feel free to squash this into any other fixes/updates that
>  may be pending.
> 
>  Regards,
>  Geoff
> 
>  Documentation/DocBook/uio-howto.tmpl |    7 ++++++-
>  1 files changed, 6 insertions(+), 1 deletions(-)
> 
> diff --git a/Documentation/DocBook/uio-howto.tmpl b/Documentation/DocBook/uio-howto.tmpl
> index bc4a709..8e98e2f 100644
> --- a/Documentation/DocBook/uio-howto.tmpl
> +++ b/Documentation/DocBook/uio-howto.tmpl
> @@ -533,6 +533,11 @@ Here's a description of the fields of <varname>struct uio_mem</varname>:
>  
>  <itemizedlist>
>  <listitem><para>
> +<varname>const char *name</varname>: Optional. Set this to help identify
> +the memory region, it will show up in the corresponding sysfs node.
> +</para></listitem>
> +
> +<listitem><para>
>  <varname>int memtype</varname>: Required if the mapping is used. Set this to
>  <varname>UIO_MEM_PHYS</varname> if you you have physical memory on your
>  card to be mapped. Use <varname>UIO_MEM_LOGICAL</varname> for logical
> @@ -565,7 +570,7 @@ instead to remember such an address.
>  </itemizedlist>
>  
>  <para>
> -Please do not touch the <varname>kobj</varname> element of
> +Please do not touch the <varname>map</varname> element of
>  <varname>struct uio_mem</varname>! It is used by the UIO framework
>  to set up sysfs files for this mapping. Simply leave it alone.
>  </para>
> -- 
> 1.7.3.4
> 
>