1 From 0cd5b9ea20e8bc315d43ba1e38ed113804e3c759 Mon Sep 17 00:00:00 2001
2 From: Guillem Jover <guillem@hadrons.org>
3 Date: Sat, 20 Jul 2019 21:18:01 +0200
4 Subject: [PATCH libaio 03/28] man: Use the correct troff macro for comments
6 Signed-off-by: Guillem Jover <guillem@hadrons.org>
7 Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
9 man/io_fsync.3 | 12 ++++++------
10 man/io_getevents.3 | 36 ++++++++++++++++++------------------
11 man/io_prep_fsync.3 | 14 +++++++-------
12 man/io_prep_pread.3 | 20 ++++++++++----------
13 man/io_prep_pwrite.3 | 20 ++++++++++----------
14 man/io_set_callback.3 | 2 +-
15 man/io_submit.3 | 24 ++++++++++++------------
16 7 files changed, 64 insertions(+), 64 deletions(-)
18 diff --git a/man/io_fsync.3 b/man/io_fsync.3
19 index 859de1b..77a62ff 100644
23 -./" static inline int io_fsync(io_context_t ctx, struct iocb *iocb, io_callback_t cb, int fd)
25 -./" io_prep_fsync(iocb, fd);
26 -./" io_set_callback(iocb, cb);
27 -./" return io_submit(ctx, 1, &iocb);
29 +.\" static inline int io_fsync(io_context_t ctx, struct iocb *iocb, io_callback_t cb, int fd)
31 +.\" io_prep_fsync(iocb, fd);
32 +.\" io_set_callback(iocb, cb);
33 +.\" return io_submit(ctx, 1, &iocb);
35 .TH io_fsync 3 2002-09-12 "Linux 2.4" Linux AIO"
37 io_fsync \- Synchronize a file's complete in-core state with that on disk
38 diff --git a/man/io_getevents.3 b/man/io_getevents.3
39 index a4f8b57..1e643ac 100644
40 --- a/man/io_getevents.3
41 +++ b/man/io_getevents.3
44 -./" * Attempts to read at least min_nr events and up to nr events from
45 -./" * the completion queue for the aio_context specified by ctx_id. May
46 -./" * fail with -EINVAL if ctx_id is invalid, if min_nr is out of range,
47 -./" * if nr is out of range, if when is out of range. May fail with
48 -./" * -EFAULT if any of the memory specified to is invalid. May return
49 -./" * 0 or < min_nr if no events are available and the timeout specified
50 -./" * by when has elapsed, where when == NULL specifies an infinite
51 -./" * timeout. Note that the timeout pointed to by when is relative and
52 -./" * will be updated if not NULL and the operation blocks. Will fail
53 -./" * with -ENOSYS if not implemented.
55 -./"asmlinkage long sys_io_getevents(io_context_t ctx_id,
58 -./" struct io_event *events,
59 -./" struct timespec *timeout)
62 +.\" * Attempts to read at least min_nr events and up to nr events from
63 +.\" * the completion queue for the aio_context specified by ctx_id. May
64 +.\" * fail with -EINVAL if ctx_id is invalid, if min_nr is out of range,
65 +.\" * if nr is out of range, if when is out of range. May fail with
66 +.\" * -EFAULT if any of the memory specified to is invalid. May return
67 +.\" * 0 or < min_nr if no events are available and the timeout specified
68 +.\" * by when has elapsed, where when == NULL specifies an infinite
69 +.\" * timeout. Note that the timeout pointed to by when is relative and
70 +.\" * will be updated if not NULL and the operation blocks. Will fail
71 +.\" * with -ENOSYS if not implemented.
73 +.\"asmlinkage long sys_io_getevents(io_context_t ctx_id,
76 +.\" struct io_event *events,
77 +.\" struct timespec *timeout)
79 .TH io_getevents 2 2002-09-03 "Linux 2.4" "Linux AIO"
81 io_getevents, aio_pgetevents \- Read resulting events from io requests
82 diff --git a/man/io_prep_fsync.3 b/man/io_prep_fsync.3
83 index 1173e2a..2daddee 100644
84 --- a/man/io_prep_fsync.3
85 +++ b/man/io_prep_fsync.3
87 -./" static inline void io_prep_fsync(struct iocb *iocb, int fd)
89 -./" memset(iocb, 0, sizeof(*iocb));
90 -./" iocb->aio_fildes = fd;
91 -./" iocb->aio_lio_opcode = IO_CMD_FSYNC;
92 -./" iocb->aio_reqprio = 0;
94 +.\" static inline void io_prep_fsync(struct iocb *iocb, int fd)
96 +.\" memset(iocb, 0, sizeof(*iocb));
97 +.\" iocb->aio_fildes = fd;
98 +.\" iocb->aio_lio_opcode = IO_CMD_FSYNC;
99 +.\" iocb->aio_reqprio = 0;
101 .TH io_prep_fsync 3 2002-09-12 "Linux 2.4" Linux AIO"
103 io_prep_fsync \- Synchronize a file's complete in-core state with that on disk
104 diff --git a/man/io_prep_pread.3 b/man/io_prep_pread.3
105 index 2c3b314..1ab28f5 100644
106 --- a/man/io_prep_pread.3
107 +++ b/man/io_prep_pread.3
109 -./" static inline void io_prep_pread(struct iocb *iocb, int fd, void *buf, size_t count, long long offset)
111 -./" memset(iocb, 0, sizeof(*iocb));
112 -./" iocb->aio_fildes = fd;
113 -./" iocb->aio_lio_opcode = IO_CMD_PREAD;
114 -./" iocb->aio_reqprio = 0;
115 -./" iocb->u.c.buf = buf;
116 -./" iocb->u.c.nbytes = count;
117 -./" iocb->u.c.offset = offset;
119 +.\" static inline void io_prep_pread(struct iocb *iocb, int fd, void *buf, size_t count, long long offset)
121 +.\" memset(iocb, 0, sizeof(*iocb));
122 +.\" iocb->aio_fildes = fd;
123 +.\" iocb->aio_lio_opcode = IO_CMD_PREAD;
124 +.\" iocb->aio_reqprio = 0;
125 +.\" iocb->u.c.buf = buf;
126 +.\" iocb->u.c.nbytes = count;
127 +.\" iocb->u.c.offset = offset;
129 .TH io_prep_pread 3 2002-09-12 "Linux 2.4" Linux AIO"
131 io_prep_pread \- Set up asynchronous read
132 diff --git a/man/io_prep_pwrite.3 b/man/io_prep_pwrite.3
133 index 669b8c2..f8d7fac 100644
134 --- a/man/io_prep_pwrite.3
135 +++ b/man/io_prep_pwrite.3
137 -./" static inline void io_prep_pwrite(struct iocb *iocb, int fd, void *buf, size_t count, long long offset)
139 -./" memset(iocb, 0, sizeof(*iocb));
140 -./" iocb->aio_fildes = fd;
141 -./" iocb->aio_lio_opcode = IO_CMD_PWRITE;
142 -./" iocb->aio_reqprio = 0;
143 -./" iocb->u.c.buf = buf;
144 -./" iocb->u.c.nbytes = count;
145 -./" iocb->u.c.offset = offset;
147 +.\" static inline void io_prep_pwrite(struct iocb *iocb, int fd, void *buf, size_t count, long long offset)
149 +.\" memset(iocb, 0, sizeof(*iocb));
150 +.\" iocb->aio_fildes = fd;
151 +.\" iocb->aio_lio_opcode = IO_CMD_PWRITE;
152 +.\" iocb->aio_reqprio = 0;
153 +.\" iocb->u.c.buf = buf;
154 +.\" iocb->u.c.nbytes = count;
155 +.\" iocb->u.c.offset = offset;
157 .TH io_prep_pwrite 3 2002-09-12 "Linux 2.4" Linux AIO"
159 io_prep_pwrite \- Set up iocb for asynchronous writes
160 diff --git a/man/io_set_callback.3 b/man/io_set_callback.3
161 index 3c7e43f..cc842f7 100644
162 --- a/man/io_set_callback.3
163 +++ b/man/io_set_callback.3
165 -./"\x03static inline void io_set_callback(struct iocb *iocb, io_callback_t cb)
166 +.\"static inline void io_set_callback(struct iocb *iocb, io_callback_t cb)
167 .TH io_set_callback 3 2002-09-12 "Linux 2.4" Linux AIO"
169 io_set_callback \- Set up io completion callback function
170 diff --git a/man/io_submit.3 b/man/io_submit.3
171 index 7281147..a810b3f 100644
172 --- a/man/io_submit.3
173 +++ b/man/io_submit.3
175 -./"/* sys_io_submit:
176 -./" * Queue the nr iocbs pointed to by iocbpp for processing. Returns
177 -./" * the number of iocbs queued. May return -EINVAL if the aio_context
178 -./" * specified by ctx_id is invalid, if nr is < 0, if the iocb at
179 -./" * *iocbpp[0] is not properly initialized, if the operation specified
180 -./" * is invalid for the file descriptor in the iocb. May fail with
181 -./" * -EFAULT if any of the data structures point to invalid data. May
182 -./" * fail with -EBADF if the file descriptor specified in the first
183 -./" * iocb is invalid. May fail with -EAGAIN if insufficient resources
184 -./" * are available to queue any iocbs. Will return 0 if nr is 0. Will
185 -./" * fail with -ENOSYS if not implemented.
187 +.\"/* sys_io_submit:
188 +.\" * Queue the nr iocbs pointed to by iocbpp for processing. Returns
189 +.\" * the number of iocbs queued. May return -EINVAL if the aio_context
190 +.\" * specified by ctx_id is invalid, if nr is < 0, if the iocb at
191 +.\" * *iocbpp[0] is not properly initialized, if the operation specified
192 +.\" * is invalid for the file descriptor in the iocb. May fail with
193 +.\" * -EFAULT if any of the data structures point to invalid data. May
194 +.\" * fail with -EBADF if the file descriptor specified in the first
195 +.\" * iocb is invalid. May fail with -EAGAIN if insufficient resources
196 +.\" * are available to queue any iocbs. Will return 0 if nr is 0. Will
197 +.\" * fail with -ENOSYS if not implemented.
199 .TH io_submit 2 2002-09-02 "Linux 2.4" "Linux AIO"
201 io_submit \- Submit io requests
203 2.26.0.292.g33ef6b2f38