Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

sync_file.txt: standardize document format

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>
Signed-off-by: Gustavo Padovan <gustavo.padovan@collabora.com>
Link: http://patchwork.freedesktop.org/patch/msgid/e781f61e582e7c7eb5de456608043aff9fe2b2b5.1495157082.git.mchehab@s-opensource.com

authored by

Mauro Carvalho Chehab and committed by
Gustavo Padovan
c16f291d 7fcd0750

+13 -10
+13 -10
Documentation/sync_file.txt
··· 1 - Sync File API Guide 2 - ~~~~~~~~~~~~~~~~~~~ 1 + =================== 2 + Sync File API Guide 3 + =================== 3 4 4 - Gustavo Padovan 5 - <gustavo at padovan dot org> 5 + :Author: Gustavo Padovan <gustavo at padovan dot org> 6 6 7 7 This document serves as a guide for device drivers writers on what the 8 8 sync_file API is, and how drivers can support it. Sync file is the carrier of ··· 46 46 47 47 When a driver needs to send an out-fence userspace it creates a sync_file. 48 48 49 - Interface: 49 + Interface:: 50 + 50 51 struct sync_file *sync_file_create(struct dma_fence *fence); 51 52 52 53 The caller pass the out-fence and gets back the sync_file. That is just the 53 54 first step, next it needs to install an fd on sync_file->file. So it gets an 54 - fd: 55 + fd:: 55 56 56 57 fd = get_unused_fd_flags(O_CLOEXEC); 57 58 58 - and installs it on sync_file->file: 59 + and installs it on sync_file->file:: 59 60 60 61 fd_install(fd, sync_file->file); 61 62 ··· 72 71 of the Sync File to the kernel. The kernel can then retrieve the fences 73 72 from it. 74 73 75 - Interface: 74 + Interface:: 75 + 76 76 struct dma_fence *sync_file_get_fence(int fd); 77 77 78 78 ··· 81 79 afterwards using dma_fence_put(). In case of error, a NULL is returned instead. 82 80 83 81 References: 84 - [1] struct sync_file in include/linux/sync_file.h 85 - [2] All interfaces mentioned above defined in include/linux/sync_file.h 82 + 83 + 1. struct sync_file in include/linux/sync_file.h 84 + 2. All interfaces mentioned above defined in include/linux/sync_file.h