[FFmpeg-cvslog] doc/utils: apply misc fixes to OpenCL docs

Stefano Sabatini git at videolan.org
Fri Apr 12 18:22:56 CEST 2013


ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Fri Apr 12 18:21:28 2013 +0200| [9ae9ae10f9fe8fc35aa9d03449da69d516d906ed] | committer: Stefano Sabatini

doc/utils: apply misc fixes to OpenCL docs

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=9ae9ae10f9fe8fc35aa9d03449da69d516d906ed
---

 doc/utils.texi |   21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/doc/utils.texi b/doc/utils.texi
index 706516a..fa57ee3 100644
--- a/doc/utils.texi
+++ b/doc/utils.texi
@@ -565,20 +565,27 @@ indication of the corresponding powers of 10 and of 2.
 @c man begin OPENCL OPTIONS
 
 When FFmpeg is configured with @code{--enable-opencl}, it is possible
-to set the options to set in the global OpenCL context. The list of
-supported options follows:
+to set the options for the global OpenCL context.
+
+The list of supported options follows:
 
 @table @option
 @item build_options
-Set build options which used to compiled kernels, see reference "OpenCL Specification Version: 1.2 chapter 5.6.4"
+Set build options used to compile the registered kernels.
+
+See reference "OpenCL Specification Version: 1.2 chapter 5.6.4".
 
 @item platform_idx
-Select platform to run OpenCL code, the platform_idx is the index of platform
-in the device list which can be obtained with av_opencl_get_device_list().
+Select the index of the platform to run OpenCL code.
+
+The specified index must be one of the indexes in the device list
+which can be obtained with av_opencl_get_device_list().
 
 @item device_idx
-Select device to run OpenCL code, the device_idx is the index of device in
-the device list which can be obtained with av_opencl_get_device_list().
+Select the index of the device used to run OpenCL code.
+
+The specifed index must be one of the indexes in the device list which
+can be obtained with av_opencl_get_device_list().
 
 @end table
 



More information about the ffmpeg-cvslog mailing list