[FFmpeg-devel] [PATCH] doc/libswresample: Fix most spelling mistakes

[Stefano Sabatini]

On date Saturday 2012-11-24 01:08:43 +0100, Stefano Sabatini encoded:
> On date Thursday 2012-11-22 23:58:49 +0100, Alexander Strasser encoded:
> > Stefano Sabatini wrote:
> > > On date Wednesday 2012-11-14 00:18:45 +0100, Clément Bœsch encoded:
> > > > On Sun, Nov 11, 2012 at 03:11:02PM +0100, Stefano Sabatini wrote:
> > [...]
> > > > > + at setfilename libswresample
> > > > > + at settitle audio conversion library
> > > 
> > > > Just like swscale, I'd add "resampling".
> > > 
> > > "resampling" would be limited, since the library perform also other
> > > conversion as well (rematrixing, format conversion, repacking), which
> > > I put under the generic label "audio conversion".
> > 
> >   I am mildly for mentioning resampling here. The most understandable
> > for outsiders (that does not conflict with terms used in FFmpeg) would
> > probably be
> > 
> > "audio resampling and sample format conversion library"
> > 
> > so probably
> > 
> > "audio resampling library"
> > 
> > is the better choice.
> 
> Changed.
> 
> >   I mean the purposes of the lib are explained right at the top of the
> > document, so users will quickly see it can do things beyond resampling.
> > I guess the term conversion in "audio conversion library" will also
> > make many think of conversion between audio file formats and codecs.
> > 
> >   But no strong opinion about this, just transmitting some thoughts
> > over the mailing list.
> 
> Updated.
> 
> I decided to keep this layout:
> 
> - a dedicated manual for each ff* tool
> 
> - a dedicated manual for each library, just listing a brief
>   description (and possibly soon a link to Doxygen)
> 
> - a dedicated manual for the library subcomponents (codecs, filters,
>   formats, etc.), including the single objects provided by a library
>   like in the case of the libswresample/libswscale libraries, which
>   still resides in the "user" documentation space.
> 
> This is meant to keep the documentation as modular as possible, and to
> keep tool and library documentation separated as much as possible.
> 
> Keeping a *huge* complete tool page should be still possible, but that
> would imply some hacks to the build system.
> -- 
> FFmpeg = Fanciful and F*c*i*g MultiPurpose Eccentric Goblin

> From 064eae6cab49686d95f3849deedb2dd8084d594d Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefasab at gmail.com>
> Date: Fri, 2 Nov 2012 12:24:04 +0100
> Subject: [PATCH] doc: add libswresample.texi and ffmpeg-resampler.texi files
> 
> ---
>  doc/Makefile              |    3 +-
>  doc/ffmpeg-resampler.texi |  198 +++++++++++++++++++++++++++++++++++++++++++++
>  doc/libswresample.texi    |   62 ++++++++++++++
>  3 files changed, 262 insertions(+), 1 deletion(-)
>  create mode 100644 doc/ffmpeg-resampler.texi
>  create mode 100644 doc/libswresample.texi

Applied.
-- 
FFmpeg = Faithful Free Mystic Perfectionist Elaborated Goblin