[FFmpeg-devel] [PATCH] developer.texi: replace "externally vissible" by public

[Clément Bœsch]

On Wed, Feb 13, 2013 at 07:14:02PM +0100, Michael Niedermayer wrote:
> On Wed, Feb 13, 2013 at 05:23:59PM +0100, Clément Bœsch wrote:
> > On Tue, Feb 12, 2013 at 04:14:45PM +0100, Michael Niedermayer wrote:
> > > A lot is externally visible, for example in static libs
> > > what the text means is intentionally public.
> > > 
> > 
> > "vissible" typo in the commit message.
> > 
> > > Signed-off-by: Michael Niedermayer <michaelni at gmx.at>
> > > ---
> > >  doc/developer.texi |    2 +-
> > >  1 file changed, 1 insertion(+), 1 deletion(-)
> > > 
> > > diff --git a/doc/developer.texi b/doc/developer.texi
> > > index c11a5ef..b2a792e 100644
> > > --- a/doc/developer.texi
> > > +++ b/doc/developer.texi
> > > @@ -165,7 +165,7 @@ prefix should be used, e.g. @samp{ff_w64_demuxer}.
> > >  For variables and functions used internally across multiple libraries, use
> > >  @code{avpriv_}. For example, @samp{avpriv_aac_parse_header}.
> > >  @item
> > > -For externally visible symbols, each library has its own prefix. Check
> > > +For public symbols, each library has its own prefix. Check
> > >  the existing code and choose names accordingly.
> > >  @end itemize
> > 
> > Why not, but the sentence sounds wrong anyway AFAICT. There is "av_" +
> > "av<something>_" for most of the libs. The rename team will certainly
> > change everything during the next years, but until then this sentence
> > remains somehow wrong.
> > 
> > What about something like:
> > 
> >   Each library has its own prefix for public symbols, in addition to the
> >   commonly used @code{av_} (@code{avformat_} for libavformat,
> >   @code{avcodec_} for libavcodec, @code{swr_} for libswresample, etc).
> >   Check the existing code and choose names accordingly.
> > 
> >   Note that some symbols without these prefixes are also exported for
> >   retro-compatibility reasons. These exceptions are declared in the
> >   @code{lib<name>/lib<name>.v} files.
> 
> sounds good, please commit
> 

Applied.

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20130213/404503d1/attachment.asc>