* [PATCH 00/29] Standardize doc formats - part 3
@ 2017-05-19 1:25 Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 20/29] sync_file.txt: standardize document format Mauro Carvalho Chehab
0 siblings, 1 reply; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2017-05-19 1:25 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab,
linux-kernel-u79uwXL29TY76Z2rM5mHXA, Jonathan Corbet,
David Woodhouse, Brian Norris, Boris Brezillon, Marek Vasut,
Richard Weinberger, Cyrille Pitchen,
linux-mtd-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r, Alessandro Zummo,
dri-devel-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW, Bjorn Andersson,
Alex Williamson, linux-pwm-u79uwXL29TY76Z2rM5mHXA,
linux-remoteproc-u79uwXL29TY76Z2rM5mHXA, Thomas Gleixner,
Ingo Molnar, kvm-u79uwXL29TY76Z2rM5mHXA, Thierry Reding,
Linus Walleij, kpreempt-tech-5NWGOfrQmneHXe+LvDLADg
Each document under Documentation/*.txt has its own format.
Some follow markup notations, some don't even have a title!
In order to try to get some order on it, change the document
style to the standard we're adopting after the adoption of
ReStructured Text.
The documents touched on this series now build fine with
Sphinx, if renamed to *.rst extension.
The main goal with this is to teach people by example about
what format is expected on newer documents. It also helps
to add those files to Kernel books.
In order to make things more palatable, I'm spliting the
conversion into three parts.
This is part 3.
Mauro Carvalho Chehab (29):
pinctrl.txt: standardize document format
pnp.txt: standardize document format
preempt-locking.txt: standardize document format
printk-formats.txt: standardize document format
pwm.txt: standardize document format
rbtree.txt: standardize document format
remoteproc.txt: standardize document format
rfkill.txt: standardize document format
robust-futex-ABI.txt: standardize document format
robust-futexes.txt: standardize document format
rpmsg.txt: standardize document format
rtc.txt: standardize document format
SAK.txt: standardize document format
sgi-ioc4.txt: standardize document format
siphash.txt: standardize document format
SM501.txt: standardize document format
smsc_ece1099.txt: standardize document format
static-keys.txt: standardize document format
svga.txt: standardize document format
sync_file.txt: standardize document format
this_cpu_ops.txt: standardize document format
unaligned-memory-access.txt: standardize document format
vfio-mediated-device.txt: standardize document format
vfio.txt: standardize document format
video-output.txt: standardize document format
xillybus.txt: standardize document format
xz.txt: standardize document format
zorro.txt: standardize document format
dell_rbu.txt: standardize document format
Documentation/SAK.txt | 65 +-
Documentation/SM501.txt | 9 +-
Documentation/dell_rbu.txt | 81 ++-
Documentation/pinctrl.txt | 1104 +++++++++++++++--------------
Documentation/pnp.txt | 343 +++++----
Documentation/preempt-locking.txt | 40 +-
Documentation/printk-formats.txt | 416 ++++++-----
Documentation/pwm.txt | 46 +-
Documentation/rbtree.txt | 88 +--
Documentation/remoteproc.txt | 320 +++++----
Documentation/rfkill.txt | 47 +-
Documentation/robust-futex-ABI.txt | 14 +-
Documentation/robust-futexes.txt | 12 +-
Documentation/rpmsg.txt | 340 +++++----
Documentation/rtc.txt | 44 +-
Documentation/sgi-ioc4.txt | 4 +
Documentation/siphash.txt | 186 ++---
Documentation/smsc_ece1099.txt | 4 +
Documentation/static-keys.txt | 199 +++---
Documentation/svga.txt | 146 ++--
Documentation/sync_file.txt | 23 +-
Documentation/this_cpu_ops.txt | 49 +-
Documentation/unaligned-memory-access.txt | 57 +-
Documentation/vfio-mediated-device.txt | 252 +++----
Documentation/vfio.txt | 261 +++----
Documentation/video-output.txt | 54 +-
Documentation/xillybus.txt | 29 +-
Documentation/xz.txt | 182 ++---
Documentation/zorro.txt | 59 +-
29 files changed, 2437 insertions(+), 2037 deletions(-)
--
2.9.4
--
You received this message because you are subscribed to "rtc-linux".
Membership options at http://groups.google.com/group/rtc-linux .
Please read http://groups.google.com/group/rtc-linux/web/checklist
before submitting a driver.
---
You received this message because you are subscribed to the Google Groups "rtc-linux" group.
To unsubscribe from this group and stop receiving emails from it, send an email to rtc-linux+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
For more options, visit https://groups.google.com/d/optout.
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH 20/29] sync_file.txt: standardize document format
2017-05-19 1:25 [PATCH 00/29] Standardize doc formats - part 3 Mauro Carvalho Chehab
@ 2017-05-19 1:26 ` Mauro Carvalho Chehab
2017-05-25 1:36 ` Gustavo Padovan
0 siblings, 1 reply; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2017-05-19 1:26 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, David Woodhouse, Brian Norris, Boris Brezillon,
Marek Vasut, Richard Weinberger, Cyrille Pitchen, linux-mtd,
Sumit Semwal, Gustavo Padovan, dri-devel
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:
- Use markup for document title and authorship;
- Mark literal blocks;
- Use a numbered list for references.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/sync_file.txt | 23 +++++++++++++----------
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/Documentation/sync_file.txt b/Documentation/sync_file.txt
index c3d033a06e8d..496fb2c3b3e6 100644
--- a/Documentation/sync_file.txt
+++ b/Documentation/sync_file.txt
@@ -1,8 +1,8 @@
- Sync File API Guide
- ~~~~~~~~~~~~~~~~~~~
+===================
+Sync File API Guide
+===================
- Gustavo Padovan
- <gustavo at padovan dot org>
+:Author: Gustavo Padovan <gustavo at padovan dot org>
This document serves as a guide for device drivers writers on what the
sync_file API is, and how drivers can support it. Sync file is the carrier of
@@ -46,16 +46,17 @@ Creating Sync Files
When a driver needs to send an out-fence userspace it creates a sync_file.
-Interface:
+Interface::
+
struct sync_file *sync_file_create(struct dma_fence *fence);
The caller pass the out-fence and gets back the sync_file. That is just the
first step, next it needs to install an fd on sync_file->file. So it gets an
-fd:
+fd::
fd = get_unused_fd_flags(O_CLOEXEC);
-and installs it on sync_file->file:
+and installs it on sync_file->file::
fd_install(fd, sync_file->file);
@@ -71,7 +72,8 @@ When userspace needs to send an in-fence to the driver it passes file descriptor
of the Sync File to the kernel. The kernel can then retrieve the fences
from it.
-Interface:
+Interface::
+
struct dma_fence *sync_file_get_fence(int fd);
@@ -79,5 +81,6 @@ The returned reference is owned by the caller and must be disposed of
afterwards using dma_fence_put(). In case of error, a NULL is returned instead.
References:
-[1] struct sync_file in include/linux/sync_file.h
-[2] All interfaces mentioned above defined in include/linux/sync_file.h
+
+1. struct sync_file in include/linux/sync_file.h
+2. All interfaces mentioned above defined in include/linux/sync_file.h
--
2.9.4
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH 20/29] sync_file.txt: standardize document format
2017-05-19 1:26 ` [PATCH 20/29] sync_file.txt: standardize document format Mauro Carvalho Chehab
@ 2017-05-25 1:36 ` Gustavo Padovan
2017-05-25 5:16 ` Mauro Carvalho Chehab
0 siblings, 1 reply; 4+ messages in thread
From: Gustavo Padovan @ 2017-05-25 1:36 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, David Woodhouse, Brian Norris, Boris Brezillon,
Marek Vasut, Richard Weinberger, Cyrille Pitchen, linux-mtd,
Sumit Semwal, dri-devel
Hi Mauro,
2017-05-18 Mauro Carvalho Chehab <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:
> - Use markup for document title and authorship;
> - Mark literal blocks;
> - Use a numbered list for references.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> ---
> Documentation/sync_file.txt | 23 +++++++++++++----------
> 1 file changed, 13 insertions(+), 10 deletions(-)
We went ahead and applied this to drm-misc-next. Thanks.
Gustavo
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH 20/29] sync_file.txt: standardize document format
2017-05-25 1:36 ` Gustavo Padovan
@ 2017-05-25 5:16 ` Mauro Carvalho Chehab
0 siblings, 0 replies; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2017-05-25 5:16 UTC (permalink / raw)
To: Gustavo Padovan
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, David Woodhouse, Brian Norris, Boris Brezillon,
Marek Vasut, Richard Weinberger, Cyrille Pitchen, linux-mtd,
Sumit Semwal, dri-devel
Em Wed, 24 May 2017 22:36:36 -0300
Gustavo Padovan <gustavo@padovan.org> escreveu:
> Hi Mauro,
>
> 2017-05-18 Mauro Carvalho Chehab <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:
> > - Use markup for document title and authorship;
> > - Mark literal blocks;
> > - Use a numbered list for references.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> > ---
> > Documentation/sync_file.txt | 23 +++++++++++++----------
> > 1 file changed, 13 insertions(+), 10 deletions(-)
>
> We went ahead and applied this to drm-misc-next. Thanks.
OK!
Thanks!
Mauro
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2017-05-25 5:16 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-05-19 1:25 [PATCH 00/29] Standardize doc formats - part 3 Mauro Carvalho Chehab
2017-05-19 1:26 ` [PATCH 20/29] sync_file.txt: standardize document format Mauro Carvalho Chehab
2017-05-25 1:36 ` Gustavo Padovan
2017-05-25 5:16 ` Mauro Carvalho Chehab
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).