[RFC] Documentation/ioctl-mess.txt format

[Alexey Dobriyan]

Now that first two patches hit -mm (thanks, Andrew), please, comment
on:

a) Layout.

   This one is a-la MAINTAINERS, CREDITS. I like it.

b) Fields for future additions.

   Input and output wrt userspace are the easiest ones to extract, so
   I'll do them first.

   Obviously, "D: " should exist (already found some good descriptions
   under GFDL, arrgh). Possibly "R: " -- return values. Following code
   can be tricky and deep.

P. S.: some of you would like to see "P: " field very much, but that
       would require a _lot_ of archaeology. ;-)

--- linux-ioctl-mess.txt-000/Documentation/ioctl-mess.txt
+++ linux-ioctl-mess.txt-001/Documentation/ioctl-mess.txt
@@ -7,23 +7,66 @@ time for patch-cooking, simple "there is
 would also be fine.
 
 Please, keep the list in alphabetical order.
+
+Legend
+------
+N: NAME
+I: data copied from userspace with copy_from_user(), or
+	"I: (int) arg", or
+	"I: -".
+O: data copied to userspace with copy_to_user() or put_user(), or
+	"O: -".
 ----------------------------------------------------------------------------
 0x1260
 0x41545900
 0x41545901
 0x4B50
 0x4B51
-ADD_NEW_DISK
-AGPIOC_ACQUIRE
-AGPIOC_ALLOCATE
-AGPIOC_BIND
-AGPIOC_DEALLOCATE
-AGPIOC_INFO
-AGPIOC_PROTECT
-AGPIOC_RELEASE
-AGPIOC_RESERVE
-AGPIOC_SETUP
-AGPIOC_UNBIND
+
+N: ADD_NEW_DISK
+I: mdu_disk_info_t
+O: -
+
+N: AGPIOC_ACQUIRE
+I: -
+O: -
+
+N: AGPIOC_ALLOCATE
+I: struct agp_allocate
+O: struct agp_allocate
+
+N: AGPIOC_BIND
+I: struct agp_bind
+O: -
+
+N: AGPIOC_DEALLOCATE
+I: int (arg)
+O: -
+
+N: AGPIOC_INFO
+I: -
+O: struct agp_info
+
+N: AGPIOC_PROTECT
+I: -
+O: -
+
+N: AGPIOC_RELEASE
+I: -
+O: -
+
+N: AGPIOC_RESERVE
+I: struct agp_region [+ sizeof(struct agp_segment) * struct agp_region::seg_count)]
+O: -
+
+N: AGPIOC_SETUP
+I: struct agp_setup
+O: -
+
+N: AGPIOC_UNBIND
+I: struct agp_unbind
+O: -
+
 AMDTP_IOC_ZAP
 APM_IOC_STANDBY
 APM_IOC_SUSPEND

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/