linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jiri Slaby <jslaby@suse.com>, Timur Tabi <timur@kernel.org>,
	linuxppc-dev@lists.ozlabs.org, linux-serial@vger.kernel.org
Subject: [PATCH 32/39] docs: serial: move it to the driver-api
Date: Fri, 28 Jun 2019 09:30:25 -0300	[thread overview]
Message-ID: <98ded3b9747e187413aab3406da2d5e7c89f53cb.1561724493.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1561724493.git.mchehab+samsung@kernel.org>

The contents of this directory is mostly driver-api stuff.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/driver-api/index.rst                       | 1 +
 Documentation/{ => driver-api}/serial/cyclades_z.rst     | 0
 Documentation/{ => driver-api}/serial/driver.rst         | 2 +-
 Documentation/{ => driver-api}/serial/index.rst          | 2 +-
 Documentation/{ => driver-api}/serial/moxa-smartio.rst   | 0
 Documentation/{ => driver-api}/serial/n_gsm.rst          | 0
 Documentation/{ => driver-api}/serial/rocket.rst         | 0
 Documentation/{ => driver-api}/serial/serial-iso7816.rst | 0
 Documentation/{ => driver-api}/serial/serial-rs485.rst   | 0
 Documentation/{ => driver-api}/serial/tty.rst            | 0
 MAINTAINERS                                              | 6 +++---
 drivers/tty/Kconfig                                      | 4 ++--
 drivers/tty/serial/ucc_uart.c                            | 2 +-
 include/linux/serial_core.h                              | 2 +-
 14 files changed, 10 insertions(+), 9 deletions(-)
 rename Documentation/{ => driver-api}/serial/cyclades_z.rst (100%)
 rename Documentation/{ => driver-api}/serial/driver.rst (99%)
 rename Documentation/{ => driver-api}/serial/index.rst (90%)
 rename Documentation/{ => driver-api}/serial/moxa-smartio.rst (100%)
 rename Documentation/{ => driver-api}/serial/n_gsm.rst (100%)
 rename Documentation/{ => driver-api}/serial/rocket.rst (100%)
 rename Documentation/{ => driver-api}/serial/serial-iso7816.rst (100%)
 rename Documentation/{ => driver-api}/serial/serial-rs485.rst (100%)
 rename Documentation/{ => driver-api}/serial/tty.rst (100%)

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index f44a3140f95d..d6f532c8d824 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -88,6 +88,7 @@ available subsections can be seen below.
    pti_intel_mid
    pwm
    rfkill
+   serial/index
    sgi-ioc4
    sm501
    smsc_ece1099
diff --git a/Documentation/serial/cyclades_z.rst b/Documentation/driver-api/serial/cyclades_z.rst
similarity index 100%
rename from Documentation/serial/cyclades_z.rst
rename to Documentation/driver-api/serial/cyclades_z.rst
diff --git a/Documentation/serial/driver.rst b/Documentation/driver-api/serial/driver.rst
similarity index 99%
rename from Documentation/serial/driver.rst
rename to Documentation/driver-api/serial/driver.rst
index 4537119bf624..31bd4e16fb1f 100644
--- a/Documentation/serial/driver.rst
+++ b/Documentation/driver-api/serial/driver.rst
@@ -311,7 +311,7 @@ hardware.
 	This call must not sleep
 
   set_ldisc(port,termios)
-	Notifier for discipline change. See Documentation/serial/tty.rst.
+	Notifier for discipline change. See Documentation/driver-api/serial/tty.rst.
 
 	Locking: caller holds tty_port->mutex
 
diff --git a/Documentation/serial/index.rst b/Documentation/driver-api/serial/index.rst
similarity index 90%
rename from Documentation/serial/index.rst
rename to Documentation/driver-api/serial/index.rst
index d0ba22ea23bf..33ad10d05b26 100644
--- a/Documentation/serial/index.rst
+++ b/Documentation/driver-api/serial/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
 
 ==========================
 Support for Serial devices
diff --git a/Documentation/serial/moxa-smartio.rst b/Documentation/driver-api/serial/moxa-smartio.rst
similarity index 100%
rename from Documentation/serial/moxa-smartio.rst
rename to Documentation/driver-api/serial/moxa-smartio.rst
diff --git a/Documentation/serial/n_gsm.rst b/Documentation/driver-api/serial/n_gsm.rst
similarity index 100%
rename from Documentation/serial/n_gsm.rst
rename to Documentation/driver-api/serial/n_gsm.rst
diff --git a/Documentation/serial/rocket.rst b/Documentation/driver-api/serial/rocket.rst
similarity index 100%
rename from Documentation/serial/rocket.rst
rename to Documentation/driver-api/serial/rocket.rst
diff --git a/Documentation/serial/serial-iso7816.rst b/Documentation/driver-api/serial/serial-iso7816.rst
similarity index 100%
rename from Documentation/serial/serial-iso7816.rst
rename to Documentation/driver-api/serial/serial-iso7816.rst
diff --git a/Documentation/serial/serial-rs485.rst b/Documentation/driver-api/serial/serial-rs485.rst
similarity index 100%
rename from Documentation/serial/serial-rs485.rst
rename to Documentation/driver-api/serial/serial-rs485.rst
diff --git a/Documentation/serial/tty.rst b/Documentation/driver-api/serial/tty.rst
similarity index 100%
rename from Documentation/serial/tty.rst
rename to Documentation/driver-api/serial/tty.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index 055db86fdd77..856db8015edd 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -10723,7 +10723,7 @@ F:	include/uapi/linux/meye.h
 MOXA SMARTIO/INDUSTIO/INTELLIO SERIAL CARD
 M:	Jiri Slaby <jirislaby@gmail.com>
 S:	Maintained
-F:	Documentation/serial/moxa-smartio.rst
+F:	Documentation/driver-api/serial/moxa-smartio.rst
 F:	drivers/tty/mxser.*
 
 MR800 AVERMEDIA USB FM RADIO DRIVER
@@ -13637,7 +13637,7 @@ ROCKETPORT DRIVER
 P:	Comtrol Corp.
 W:	http://www.comtrol.com
 S:	Maintained
-F:	Documentation/serial/rocket.rst
+F:	Documentation/driver-api/serial/rocket.rst
 F:	drivers/tty/rocket*
 
 ROCKETPORT EXPRESS/INFINITY DRIVER
@@ -16170,7 +16170,7 @@ M:	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
 M:	Jiri Slaby <jslaby@suse.com>
 S:	Supported
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/tty.git
-F:	Documentation/serial/
+F:	Documentation/driver-api/serial/
 F:	drivers/tty/
 F:	drivers/tty/serial/serial_core.c
 F:	include/linux/serial_core.h
diff --git a/drivers/tty/Kconfig b/drivers/tty/Kconfig
index ee51b9514225..c7623f99ac0f 100644
--- a/drivers/tty/Kconfig
+++ b/drivers/tty/Kconfig
@@ -175,7 +175,7 @@ config ROCKETPORT
 	  This driver supports Comtrol RocketPort and RocketModem PCI boards.   
           These boards provide 2, 4, 8, 16, or 32 high-speed serial ports or
           modems.  For information about the RocketPort/RocketModem  boards
-          and this driver read <file:Documentation/serial/rocket.rst>.
+          and this driver read <file:Documentation/driver-api/serial/rocket.rst>.
 
 	  To compile this driver as a module, choose M here: the
 	  module will be called rocket.
@@ -193,7 +193,7 @@ config CYCLADES
 	  your Linux box, for instance in order to become a dial-in server.
 
 	  For information about the Cyclades-Z card, read
-	  <file:Documentation/serial/cyclades_z.rst>.
+	  <file:Documentation/driver-api/serial/cyclades_z.rst>.
 
 	  To compile this driver as a module, choose M here: the
 	  module will be called cyclades.
diff --git a/drivers/tty/serial/ucc_uart.c b/drivers/tty/serial/ucc_uart.c
index 6e3c66ab0e62..a0555ae2b1ef 100644
--- a/drivers/tty/serial/ucc_uart.c
+++ b/drivers/tty/serial/ucc_uart.c
@@ -1081,7 +1081,7 @@ static int qe_uart_verify_port(struct uart_port *port,
 }
 /* UART operations
  *
- * Details on these functions can be found in Documentation/serial/driver.rst
+ * Details on these functions can be found in Documentation/driver-api/serial/driver.rst
  */
 static const struct uart_ops qe_uart_pops = {
 	.tx_empty       = qe_uart_tx_empty,
diff --git a/include/linux/serial_core.h b/include/linux/serial_core.h
index 05b179015d6c..2b78cc734719 100644
--- a/include/linux/serial_core.h
+++ b/include/linux/serial_core.h
@@ -32,7 +32,7 @@ struct device;
 
 /*
  * This structure describes all the operations that can be done on the
- * physical hardware.  See Documentation/serial/driver.rst for details.
+ * physical hardware.  See Documentation/driver-api/serial/driver.rst for details.
  */
 struct uart_ops {
 	unsigned int	(*tx_empty)(struct uart_port *);
-- 
2.21.0


  parent reply	other threads:[~2019-06-28 12:32 UTC|newest]

Thread overview: 56+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-28 12:29 [PATCH 00/39] Don't let ReST documents orphaned Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 01/39] docs: thermal: add it to the driver API Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 02/39] docs: rapidio: " Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 03/39] docs: perf: move to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 04/39] docs: nvdimm: add it to the driver-api book Mauro Carvalho Chehab
2019-06-28 16:33   ` Dan Williams
2019-06-28 12:29 ` [PATCH 05/39] docs: namespace: move it to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:29 ` [PATCH 06/39] docs: mtd: move it to the driver-api book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 07/39] docs: nfc: add " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 08/39] docs: mmc: move it to the driver-api Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 09/39] docs: md: move it to the driver-api book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 10/39] docs: leds: add " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 11/39] docs: ioctl: add it to the uAPI guide Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 12/39] docs: interconnect.rst: add it to the driver-api guide Mauro Carvalho Chehab
2019-06-28 13:55   ` Georgi Djakov
2019-06-28 12:30 ` [PATCH 13/39] docs: add arch doc directories to the index Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 14/39] docs: device-mapper: move it to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 15/39] docs: early-userspace: move to driver-api guide Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 16/39] docs: admin-guide: move sysctl directory to it Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 17/39] docs: admin-guide: add laptops documentation Mauro Carvalho Chehab
2019-06-28 14:51   ` Andy Shevchenko
2019-06-28 12:30 ` [PATCH 18/39] docs: admin-guide: add kdump documentation into it Mauro Carvalho Chehab
2019-07-05  3:43   ` Alex Shi
2019-07-05  5:59     ` Dave Young
2019-07-06 11:46       ` Mauro Carvalho Chehab
2019-07-05  5:55   ` Dave Young
2019-06-28 12:30 ` [PATCH 19/39] docs: blockdev: add it to the admin-guide Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 20/39] docs: security: move some books to it and update Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 21/39] docs: x86: move two x86-specific files to x86 arch dir Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 22/39] docs: ocxl.rst: add it to the uAPI book Mauro Carvalho Chehab
2019-07-01  1:21   ` Andrew Donnellan
2019-06-28 12:30 ` [PATCH 23/39] docs: lp855x-driver.rst: add it to the driver-api book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 24/39] docs: driver-model: move " Mauro Carvalho Chehab
2019-06-28 18:53   ` Jeff Kirsher
2019-06-28 12:30 ` [PATCH 25/39] docs: add some documentation dirs " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 26/39] docs: aoe: add it " Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 27/39] docs: cgroup-v1: add it to the admin-guide book Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 28/39] docs: admin-guide: add a series of orphaned documents Mauro Carvalho Chehab
2019-06-28 12:43   ` Alexandre Belloni
2019-06-28 12:54   ` Bartlomiej Zolnierkiewicz
2019-06-28 12:30 ` [PATCH 30/39] docs: driver-api: add xilinx driver API documentation Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 31/39] docs: driver-api: add remaining converted dirs to it Mauro Carvalho Chehab
2019-06-28 12:30 ` Mauro Carvalho Chehab [this message]
2019-06-28 12:30 ` [PATCH 33/39] docs: phy: place documentation under driver-api Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 34/39] docs: add a memory-devices subdir to driver-api Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 35/39] docs: infiniband: add it to the driver-api bookset Mauro Carvalho Chehab
2019-07-03 18:08   ` Jason Gunthorpe
2019-07-06 11:19     ` Mauro Carvalho Chehab
2019-07-08 17:25       ` Jason Gunthorpe
2019-06-28 12:30 ` [PATCH 36/39] docs: add SPDX tags to new index files Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 37/39] docs: adds some directories to the main documentation index Mauro Carvalho Chehab
2019-06-28 12:55   ` Bartlomiej Zolnierkiewicz
2019-06-28 12:30 ` [PATCH 38/39] docs: locking: add it to the main index Mauro Carvalho Chehab
2019-06-28 12:30 ` [PATCH 39/39] docs: gpio: add sysfs interface to the admin-guide Mauro Carvalho Chehab
2019-07-03  8:44   ` Linus Walleij
2019-07-06 11:43     ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=98ded3b9747e187413aab3406da2d5e7c89f53cb.1561724493.git.mchehab+samsung@kernel.org \
    --to=mchehab+samsung@kernel.org \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=jslaby@suse.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-serial@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.org \
    --cc=mchehab@infradead.org \
    --cc=timur@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).