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>,
	Richard Cochran <richardcochran@gmail.com>,
	"David S. Miller" <davem@davemloft.net>,
	netdev@vger.kernel.org
Subject: [PATCH v3 23/33] docs: ptp.txt: convert to ReST and move to driver-api
Date: Sat,  8 Jun 2019 23:27:13 -0300	[thread overview]
Message-ID: <1736539355fdee1effe3b332cf3d93124394672b.1560045490.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1560045490.git.mchehab+samsung@kernel.org>

The conversion is trivial: just adjust title markups.

In order to avoid conflicts, let's add an :orphan: tag
to it, to be removed when this file gets added to the
driver-api book.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 .../{ptp/ptp.txt => driver-api/ptp.rst}       | 26 +++++++++++++------
 Documentation/networking/timestamping.txt     |  2 +-
 MAINTAINERS                                   |  2 +-
 3 files changed, 20 insertions(+), 10 deletions(-)
 rename Documentation/{ptp/ptp.txt => driver-api/ptp.rst} (88%)

diff --git a/Documentation/ptp/ptp.txt b/Documentation/driver-api/ptp.rst
similarity index 88%
rename from Documentation/ptp/ptp.txt
rename to Documentation/driver-api/ptp.rst
index 11e904ee073f..b6e65d66d37a 100644
--- a/Documentation/ptp/ptp.txt
+++ b/Documentation/driver-api/ptp.rst
@@ -1,5 +1,8 @@
+:orphan:
 
-* PTP hardware clock infrastructure for Linux
+===========================================
+PTP hardware clock infrastructure for Linux
+===========================================
 
   This patch set introduces support for IEEE 1588 PTP clocks in
   Linux. Together with the SO_TIMESTAMPING socket options, this
@@ -22,7 +25,8 @@
     - Period output signals configurable from user space
     - Synchronization of the Linux system time via the PPS subsystem
 
-** PTP hardware clock kernel API
+PTP hardware clock kernel API
+=============================
 
    A PTP clock driver registers itself with the class driver. The
    class driver handles all of the dealings with user space. The
@@ -36,7 +40,8 @@
    development, it can be useful to have more than one clock in a
    single system, in order to allow performance comparisons.
 
-** PTP hardware clock user space API
+PTP hardware clock user space API
+=================================
 
    The class driver also creates a character device for each
    registered clock. User space can use an open file descriptor from
@@ -49,7 +54,8 @@
    ancillary clock features. User space can receive time stamped
    events via blocking read() and poll().
 
-** Writing clock drivers
+Writing clock drivers
+=====================
 
    Clock drivers include include/linux/ptp_clock_kernel.h and register
    themselves by presenting a 'struct ptp_clock_info' to the
@@ -66,14 +72,17 @@
    class driver, since the lock may also be needed by the clock
    driver's interrupt service routine.
 
-** Supported hardware
+Supported hardware
+==================
+
+   * Freescale eTSEC gianfar
 
-   + Freescale eTSEC gianfar
      - 2 Time stamp external triggers, programmable polarity (opt. interrupt)
      - 2 Alarm registers (optional interrupt)
      - 3 Periodic signals (optional interrupt)
 
-   + National DP83640
+   * National DP83640
+
      - 6 GPIOs programmable as inputs or outputs
      - 6 GPIOs with dedicated functions (LED/JTAG/clock) can also be
        used as general inputs or outputs
@@ -81,6 +90,7 @@
      - GPIO outputs can produce periodic signals
      - 1 interrupt pin
 
-   + Intel IXP465
+   * Intel IXP465
+
      - Auxiliary Slave/Master Mode Snapshot (optional interrupt)
      - Target Time (optional interrupt)
diff --git a/Documentation/networking/timestamping.txt b/Documentation/networking/timestamping.txt
index bbdaf8990031..8dd6333c3270 100644
--- a/Documentation/networking/timestamping.txt
+++ b/Documentation/networking/timestamping.txt
@@ -368,7 +368,7 @@ ts[1] used to hold hardware timestamps converted to system time.
 Instead, expose the hardware clock device on the NIC directly as
 a HW PTP clock source, to allow time conversion in userspace and
 optionally synchronize system time with a userspace PTP stack such
-as linuxptp. For the PTP clock API, see Documentation/ptp/ptp.txt.
+as linuxptp. For the PTP clock API, see Documentation/driver-api/ptp.rst.
 
 Note that if the SO_TIMESTAMP or SO_TIMESTAMPNS option is enabled
 together with SO_TIMESTAMPING using SOF_TIMESTAMPING_SOFTWARE, a false
diff --git a/MAINTAINERS b/MAINTAINERS
index b982622ea7ee..72d1e5da0779 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -12795,7 +12795,7 @@ L:	netdev@vger.kernel.org
 S:	Maintained
 W:	http://linuxptp.sourceforge.net/
 F:	Documentation/ABI/testing/sysfs-ptp
-F:	Documentation/ptp/*
+F:	Documentation/driver-api/ptp.rst
 F:	drivers/net/phy/dp83640*
 F:	drivers/ptp/*
 F:	include/linux/ptp_cl*
-- 
2.21.0


  parent reply	other threads:[~2019-06-09  2:27 UTC|newest]

Thread overview: 59+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-09  2:26 [PATCH v3 00/33] Convert files to ReST - part 1 Mauro Carvalho Chehab
2019-06-09  2:26 ` [PATCH v3 01/33] docs: aoe: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-06-09  2:26 ` [PATCH v3 02/33] docs: arm64: convert docs to ReST and rename to .rst Mauro Carvalho Chehab
2019-06-09  2:26 ` [PATCH v3 03/33] docs: cdrom-standard.tex: convert from LaTeX to ReST Mauro Carvalho Chehab
2019-06-09  2:26 ` [PATCH v3 04/33] docs: cdrom: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-06-09  2:26 ` [PATCH v3 05/33] docs: cgroup-v1: " Mauro Carvalho Chehab
2019-06-11 19:03   ` Tejun Heo
2019-06-09  2:26 ` [PATCH v3 06/33] docs: cgroup-v1/blkio-controller.rst: add a note about CFQ scheduler Mauro Carvalho Chehab
2019-06-09  2:26 ` [PATCH v3 07/33] docs: cpu-freq: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-06-09 21:38   ` Rafael J. Wysocki
2019-06-10  0:27     ` Mauro Carvalho Chehab
2019-06-09  2:26 ` [PATCH v3 08/33] docs: " Mauro Carvalho Chehab
2019-06-09  2:26 ` [PATCH v3 09/33] docs: fault-injection: " Mauro Carvalho Chehab
2019-06-10 16:24   ` Federico Vaga
2019-06-09  2:27 ` [PATCH v3 10/33] docs: fb: " Mauro Carvalho Chehab
2019-06-09  7:54   ` Geert Uytterhoeven
2019-06-09  2:27 ` [PATCH v3 11/33] docs: fpga: " Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 12/33] docs: ide: " Mauro Carvalho Chehab
2019-06-09  7:50   ` Geert Uytterhoeven
2019-06-09  2:27 ` [PATCH v3 13/33] docs: infiniband: " Mauro Carvalho Chehab
2019-06-10 17:27   ` Jason Gunthorpe
2019-06-10 17:35     ` Jonathan Corbet
2019-06-25 13:24   ` Jason Gunthorpe
2019-06-09  2:27 ` [PATCH v3 15/33] docs: kdump: " Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 16/33] docs: locking: " Mauro Carvalho Chehab
2019-06-10 16:26   ` Federico Vaga
2019-06-09  2:27 ` [PATCH v3 17/33] docs: mic: " Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 18/33] docs: netlabel: " Mauro Carvalho Chehab
2019-06-12 14:48   ` Paul Moore
2019-06-09  2:27 ` [PATCH v3 19/33] docs: pcmcia: " Mauro Carvalho Chehab
2019-06-09  6:59   ` Dominik Brodowski
2019-06-09  2:27 ` [PATCH v3 20/33] docs: " Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 21/33] docs: powerpc: " Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 22/33] docs: pps.txt: convert to ReST and rename to pps.rst Mauro Carvalho Chehab
2019-06-09  9:20   ` Rodolfo Giometti
2019-06-09  2:27 ` Mauro Carvalho Chehab [this message]
2019-06-09 13:45   ` [PATCH v3 23/33] docs: ptp.txt: convert to ReST and move to driver-api Richard Cochran
2019-06-09  2:27 ` [PATCH v3 24/33] docs: riscv: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 25/33] docs: Debugging390.txt: convert table to ascii artwork Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 26/33] docs: s390: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 27/33] s390: include/asm/debug.h add kerneldoc markups Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 28/33] docs: target: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 29/33] docs: timers: " Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 30/33] docs: watchdog: " Mauro Carvalho Chehab
2019-06-09 20:51   ` Guenter Roeck
2019-06-09  2:27 ` [PATCH v3 31/33] docs: xilinx: convert eemi.txt to eemi.rst Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 32/33] docs: scheduler: convert docs to ReST and rename to *.rst Mauro Carvalho Chehab
2019-06-09  2:27 ` [PATCH v3 33/33] docs: EDID/HOWTO.txt: convert it and rename to howto.rst Mauro Carvalho Chehab
2019-06-11  8:37   ` Daniel Vetter
2019-06-11  9:02     ` Mauro Carvalho Chehab
2019-06-11  9:40       ` Daniel Vetter
2019-06-11 15:37       ` Jonathan Corbet
2019-06-12 17:40         ` Mauro Carvalho Chehab
2019-06-12 19:45           ` Daniel Vetter
2019-06-09  9:16 ` [PATCH v3 00/33] Convert files to ReST - part 1 Heiko Carstens
2019-06-09  9:22   ` Markus Heiser
2019-06-09  9:27     ` Heiko Carstens
2019-06-09 12:29   ` Mauro Carvalho Chehab
2019-06-10 15:55     ` Heiko Carstens

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=1736539355fdee1effe3b332cf3d93124394672b.1560045490.git.mchehab+samsung@kernel.org \
    --to=mchehab+samsung@kernel.org \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=netdev@vger.kernel.org \
    --cc=richardcochran@gmail.com \
    /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).