[FFmpeg-devel] [PATCH 2/2] Add documentation regarding MIPS optimizations

[Stefano Sabatini]

On date Thursday 2012-06-21 12:04:17 +0200, Nedeljko Babic encoded:
> Documentation with short explanation regarding targeted platform
>  for MIPS optimizations and regarding MIPS copyright notice added.
> 
> Signed-off-by: Nedeljko Babic <nbabic at mips.com>
> ---
>  doc/ffmpeg.texi |    1 +
>  doc/mips.texi   |   63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 64 insertions(+), 0 deletions(-)
>  create mode 100644 doc/mips.texi
> 
> diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> index 9b4ba14..4d68192 100644
> --- a/doc/ffmpeg.texi
> +++ b/doc/ffmpeg.texi
> @@ -1267,6 +1267,7 @@ ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
>  @include bitstream_filters.texi
>  @include filters.texi
>  @include metadata.texi
> + at include mips.texi

I don't think it is a good idea to add this in the *user manual*
(also, why *only* ffmpeg.texi?)

>  
>  @ignore
>  
> diff --git a/doc/mips.texi b/doc/mips.texi
> new file mode 100644
> index 0000000..899772d
> --- /dev/null
> +++ b/doc/mips.texi
> @@ -0,0 +1,63 @@
> + at unnumbered MIPS optimizations info
> + at c man begin MIPS
> +
> +MIPS optimizations of codecs are targeting MIPS 74k family of CPUs. Some of these optimizations are
> +@*relying more on properties of this architecture and some are relying less (and can be used on most
> +@*MIPS architectures without degradation in performance).
> +
> +@*Along with FFMPEG copyright notice, there is MIPS copyright notice in all the files that are created by
> +@*people from MIPS Technologies.

I suggest to move this to a dedicated txt file in doc.

[...]
-- 
FFmpeg = Fascinating Forgiving Murdering Prodigious Ecstatic Game