Re: [PATCH 5/5] documentation: firewire: add introduction/overview text

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi,

On Feb 22 2018 10:08, Randy Dunlap wrote:
From: Takashi Sakamoto <o-takashi@xxxxxxxxxxxxx>

Replace the Introduction section's TBD with some useful overview text.

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

- Not-yet-Signed-off-by: Takashi Sakamoto <o-takashi@xxxxxxxxxxxxx>
+ Signed-off-by: Takashi Sakamoto <o-takashi@xxxxxxxxxxxxx>

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
---
  Documentation/driver-api/firewire.rst |   18 +++++++++++++++++-
  1 file changed, 17 insertions(+), 1 deletion(-)

--- linux-next-20180220.orig/Documentation/driver-api/firewire.rst
+++ linux-next-20180220/Documentation/driver-api/firewire.rst
@@ -5,17 +5,33 @@ Firewire (IEEE 1394) driver Interface Gu
  Introduction and Overview
  =========================
-TBD
+The Linux FireWire subsystem adds some interfaces into the Linux system
+to use/maintain any resource on the IEEE 1394 bus.
+
+The main purpose of these interfaces is to access address space on each node
+on the IEEE 1394 bus by ISO/IEC 13213 (IEEE 1212) procedure, and to control
+isochronous resources on the bus by IEEE 1394 procedure.
+
+Two types of interfaces are added, according to consumers of the interface. A
+set of userspace interfaces is available via `firewire character devices`. A set
+of kernel interfaces is available via exported symbols in the `firewire-core`
+module.
Firewire char device data structures
  ====================================
+.. include:: /ABI/stable/firewire-cdev
+    :literal:
+
  .. kernel-doc:: include/uapi/linux/firewire-cdev.h
      :internal:
Firewire device probing and sysfs interfaces
  ============================================
+.. include:: /ABI/stable/sysfs-bus-firewire
+    :literal:
+
  .. kernel-doc:: drivers/firewire/core-device.c
      :export:

Thanks

Takashi Sakamoto
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux