Re: [PATCH 4/5 resend] documentation: firewire: add basic firewire.rst to driver-api

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

 



Hi,

On Feb 22 2018 10:07, Randy Dunlap wrote:
From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Add a basic Firewire/IEEE 1394 driver API chapter to the Linux
kernel documentation.

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Cc:	Stefan Richter <stefanr@xxxxxxxxxxxxxxxxx>
Cc:	linux1394-devel@xxxxxxxxxxxxxxxxxxxxx
---
  Documentation/driver-api/firewire.rst |   33 ++++++++++++++++++++++++
  Documentation/driver-api/index.rst    |    1
  2 files changed, 34 insertions(+)

--- /dev/null
+++ linux-next-20180220/Documentation/driver-api/firewire.rst
@@ -0,0 +1,33 @@
+===========================================
+Firewire (IEEE 1394) driver Interface Guide
+===========================================
+
+Introduction and Overview
+=========================
+
+TBD
+
+Firewire char device data structures
+====================================
+
+.. kernel-doc:: include/uapi/linux/firewire-cdev.h
+    :internal:
+
+Firewire device probing and sysfs interfaces
+============================================
+
+.. kernel-doc:: drivers/firewire/core-device.c
+    :export:
+
+Firewire core transaction interfaces
+====================================
+
+.. kernel-doc:: drivers/firewire/core-transaction.c
+    :export:
+
+Firewire Isochronous I/O interfaces
+===================================
+
+.. kernel-doc:: drivers/firewire/core-iso.c
+   :export:
+

A command of 'git am' generates below warning when applying this patch.

```
$ git am /tmp/patches/*
Applying: documentation: firewire: add basic firewire.rst to driver-api
.git/rebase-apply/patch:41: new blank line at EOF.
+
```

It's better to remove the blank line.

--- linux-next-20180220.orig/Documentation/driver-api/index.rst
+++ linux-next-20180220/Documentation/driver-api/index.rst
@@ -27,6 +27,7 @@ available subsections can be seen below.
     iio/index
     input
     usb/index
+   firewire
     pci
     spi
     i2c


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