From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
David Woodhouse <dwmw2@infradead.org>,
Brian Norris <computersforpeace@gmail.com>,
Boris Brezillon <boris.brezillon@free-electrons.com>,
Marek Vasut <marek.vasut@gmail.com>,
Richard Weinberger <richard@nod.at>,
Cyrille Pitchen <cyrille.pitchen@atmel.com>,
linux-mtd@lists.infradead.org,
Alessandro Zummo <a.zummo@towertech.it>,
Alexandre Belloni <alexandre.belloni@free-electrons.com>,
rtc-linux@googlegroups.com
Subject: [PATCH 12/29] rtc.txt: standardize document format
Date: Thu, 18 May 2017 22:25:56 -0300 [thread overview]
Message-ID: <de62f8091ae4e7d2af980e6cd79071348622cdc8.1495157082.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1495157082.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1495157082.git.mchehab@s-opensource.com>
Each text file under Documentation follows a different
format. Some doesn't even have titles!
Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:
- adjust identation of the titles;
- mark a table as such;
- don't capitalize chapter names.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/rtc.txt | 44 +++++++++++++++++++++++---------------------
1 file changed, 23 insertions(+), 21 deletions(-)
diff --git a/Documentation/rtc.txt b/Documentation/rtc.txt
index ddc366026e00..47feb4414b7e 100644
--- a/Documentation/rtc.txt
+++ b/Documentation/rtc.txt
@@ -1,6 +1,6 @@
-
- Real Time Clock (RTC) Drivers for Linux
- =======================================
+=======================================
+Real Time Clock (RTC) Drivers for Linux
+=======================================
When Linux developers talk about a "Real Time Clock", they usually mean
something that tracks wall clock time and is battery backed so that it
@@ -32,8 +32,8 @@ only issue an alarm up to 24 hours in the future, other hardware may
be able to schedule one any time in the upcoming century.
- Old PC/AT-Compatible driver: /dev/rtc
- --------------------------------------
+Old PC/AT-Compatible driver: /dev/rtc
+--------------------------------------
All PCs (even Alpha machines) have a Real Time Clock built into them.
Usually they are built into the chipset of the computer, but some may
@@ -105,8 +105,8 @@ that will be using this driver. See the code at the end of this document.
(The original /dev/rtc driver was written by Paul Gortmaker.)
- New portable "RTC Class" drivers: /dev/rtcN
- --------------------------------------------
+New portable "RTC Class" drivers: /dev/rtcN
+--------------------------------------------
Because Linux supports many non-ACPI and non-PC platforms, some of which
have more than one RTC style clock, it needed a more portable solution
@@ -136,35 +136,37 @@ a high functionality RTC is integrated into the SOC. That system might read
the system clock from the discrete RTC, but use the integrated one for all
other tasks, because of its greater functionality.
-SYSFS INTERFACE
+SYSFS interface
---------------
The sysfs interface under /sys/class/rtc/rtcN provides access to various
rtc attributes without requiring the use of ioctls. All dates and times
are in the RTC's timezone, rather than in system time.
-date: RTC-provided date
-hctosys: 1 if the RTC provided the system time at boot via the
+================ ==============================================================
+date RTC-provided date
+hctosys 1 if the RTC provided the system time at boot via the
CONFIG_RTC_HCTOSYS kernel option, 0 otherwise
-max_user_freq: The maximum interrupt rate an unprivileged user may request
+max_user_freq The maximum interrupt rate an unprivileged user may request
from this RTC.
-name: The name of the RTC corresponding to this sysfs directory
-since_epoch: The number of seconds since the epoch according to the RTC
-time: RTC-provided time
-wakealarm: The time at which the clock will generate a system wakeup
+name The name of the RTC corresponding to this sysfs directory
+since_epoch The number of seconds since the epoch according to the RTC
+time RTC-provided time
+wakealarm The time at which the clock will generate a system wakeup
event. This is a one shot wakeup event, so must be reset
- after wake if a daily wakeup is required. Format is seconds since
- the epoch by default, or if there's a leading +, seconds in the
- future, or if there is a leading +=, seconds ahead of the current
- alarm.
-offset: The amount which the rtc clock has been adjusted in firmware.
+ after wake if a daily wakeup is required. Format is seconds
+ since the epoch by default, or if there's a leading +, seconds
+ in the future, or if there is a leading +=, seconds ahead of
+ the current alarm.
+offset The amount which the rtc clock has been adjusted in firmware.
Visible only if the driver supports clock offset adjustment.
The unit is parts per billion, i.e. The number of clock ticks
which are added to or removed from the rtc's base clock per
billion ticks. A positive value makes a day pass more slowly,
longer, and a negative value makes a day pass more quickly.
+================ ==============================================================
-IOCTL INTERFACE
+IOCTL interface
---------------
The ioctl() calls supported by /dev/rtc are also supported by the RTC class
--
2.9.4
next prev parent reply other threads:[~2017-05-19 1:32 UTC|newest]
Thread overview: 45+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-05-19 1:25 [PATCH 00/29] Standardize doc formats - part 3 Mauro Carvalho Chehab
2017-05-19 1:25 ` [PATCH 01/29] pinctrl.txt: standardize document format Mauro Carvalho Chehab
2017-05-23 9:12 ` Linus Walleij
2017-06-17 15:03 ` Mauro Carvalho Chehab
2017-06-20 11:12 ` Linus Walleij
2017-05-19 1:25 ` [PATCH 02/29] pnp.txt: " Mauro Carvalho Chehab
2017-05-19 1:25 ` [PATCH 03/29] preempt-locking.txt: " Mauro Carvalho Chehab
2017-05-19 1:25 ` [PATCH 04/29] printk-formats.txt: " Mauro Carvalho Chehab
2017-05-19 10:26 ` Joe Perches
2017-05-19 20:28 ` Mauro Carvalho Chehab
2017-05-19 23:37 ` Randy Dunlap
2017-06-17 14:55 ` Mauro Carvalho Chehab
2017-05-19 1:25 ` [PATCH 05/29] pwm.txt: " Mauro Carvalho Chehab
2017-05-19 1:25 ` [PATCH 06/29] rbtree.txt: " Mauro Carvalho Chehab
2017-05-19 1:25 ` [PATCH 07/29] remoteproc.txt: " Mauro Carvalho Chehab
2017-05-19 1:25 ` [PATCH 08/29] rfkill.txt: " Mauro Carvalho Chehab
2017-05-19 10:15 ` Johannes Berg
2017-05-19 11:11 ` Mauro Carvalho Chehab
2017-05-19 11:16 ` Johannes Berg
2017-05-19 1:25 ` [PATCH 09/29] robust-futex-ABI.txt: " Mauro Carvalho Chehab
2017-05-19 1:25 ` [PATCH 10/29] robust-futexes.txt: " Mauro Carvalho Chehab
2017-05-19 1:25 ` [PATCH 11/29] rpmsg.txt: " Mauro Carvalho Chehab
2017-05-19 1:25 ` Mauro Carvalho Chehab [this message]
2017-05-31 11:17 ` [PATCH 12/29] rtc.txt: " Alexandre Belloni
2017-05-19 1:25 ` [PATCH 13/29] SAK.txt: " Mauro Carvalho Chehab
2017-05-19 1:25 ` [PATCH 14/29] sgi-ioc4.txt: " Mauro Carvalho Chehab
2017-05-19 1:25 ` [PATCH 15/29] siphash.txt: " Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 16/29] SM501.txt: " Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 17/29] smsc_ece1099.txt: " Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 18/29] static-keys.txt: " Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 19/29] svga.txt: " Mauro Carvalho Chehab
2017-05-19 13:50 ` Martin Mares
2017-05-19 1:26 ` [PATCH 20/29] sync_file.txt: " Mauro Carvalho Chehab
2017-05-25 1:36 ` Gustavo Padovan
2017-05-25 5:16 ` Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 21/29] this_cpu_ops.txt: " Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 22/29] unaligned-memory-access.txt: " Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 23/29] vfio-mediated-device.txt: " Mauro Carvalho Chehab
2017-05-22 19:38 ` Kirti Wankhede
2017-05-19 1:26 ` [PATCH 24/29] vfio.txt: " Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 25/29] video-output.txt: " Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 26/29] xillybus.txt: " Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 27/29] xz.txt: " Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 28/29] zorro.txt: " Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 29/29] dell_rbu.txt: " 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=de62f8091ae4e7d2af980e6cd79071348622cdc8.1495157082.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=a.zummo@towertech.it \
--cc=alexandre.belloni@free-electrons.com \
--cc=boris.brezillon@free-electrons.com \
--cc=computersforpeace@gmail.com \
--cc=corbet@lwn.net \
--cc=cyrille.pitchen@atmel.com \
--cc=dwmw2@infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mtd@lists.infradead.org \
--cc=marek.vasut@gmail.com \
--cc=mchehab@infradead.org \
--cc=richard@nod.at \
--cc=rtc-linux@googlegroups.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
all inboxes | Powered by JetHome®