[FFmpeg-devel] [PATCH] examples: add README file with simple compilation instructions

[Michael Niedermayer]

On Tue, Oct 16, 2012 at 01:35:42PM +0200, Stefano Sabatini wrote:
> On date Tuesday 2012-10-16 00:04:44 +0200, Clément Bœsch encoded:
> > On Mon, Oct 15, 2012 at 11:02:08PM +0200, Stefano Sabatini wrote:
> > > On date Friday 2012-09-14 02:19:44 +0200, Clément Bœsch encoded:
> > > > On Thu, Sep 13, 2012 at 09:50:07PM +0200, Stefano Sabatini wrote:
> > > [...]
> > > > PS: thanks for writing that README, and sorry to be nitpicking so much
> > > > (but since it's for users I believe details are important to avoid any
> > > > confusion).
> > > 
> > > Rewritten, based on a variant proposed by Clement, which looks simpler
> > > and possible more clear.
> > > -- 
> > > FFmpeg = Fundamentalist and Funny Magic Problematic Elegant Ghost
> > 
> > > From 887994636e3329eb7b46c688283765a722114219 Mon Sep 17 00:00:00 2001
> > > From: Stefano Sabatini <stefasab at gmail.com>
> > > Date: Thu, 13 Sep 2012 21:12:56 +0200
> > > Subject: [PATCH] examples: add README file with simple compilation
> > >  instructions
> > > 
> > > ---
> > >  Makefile            |    2 +-
> > >  doc/examples/README |   18 ++++++++++++++++++
> > >  2 files changed, 19 insertions(+), 1 deletions(-)
> > >  create mode 100644 doc/examples/README
> > > 
> > > diff --git a/Makefile b/Makefile
> > > index 303f80f..0abb300 100644
> > > --- a/Makefile
> > > +++ b/Makefile
> > > @@ -41,7 +41,7 @@ FFLIBS-$(CONFIG_SWSCALE)  += swscale
> > >  FFLIBS := avutil
> > >  
> > >  DATA_FILES := $(wildcard $(SRC_PATH)/presets/*.ffpreset) $(SRC_PATH)/doc/ffprobe.xsd
> > > -EXAMPLES_FILES := $(wildcard $(SRC_PATH)/doc/examples/*.c) $(SRC_PATH)/doc/examples/Makefile
> > > +EXAMPLES_FILES := $(wildcard $(SRC_PATH)/doc/examples/*.c) $(SRC_PATH)/doc/examples/Makefile $(SRC_PATH)/doc/examples/README
> > >  
> > >  SKIPHEADERS = cmdutils_common_opts.h
> > >  
> > > diff --git a/doc/examples/README b/doc/examples/README
> > > new file mode 100644
> > > index 0000000..84362d4
> > > --- /dev/null
> > > +++ b/doc/examples/README
> > > @@ -0,0 +1,18 @@
> > > +FFmpeg examples README
> > > +----------------------
> > > +
> > > +Both following use case rely on pkg-config and make, thus make sure
> > 
> > use caseS?
> > 
> > > +that you have them installed and working on your system.
> > > +
> > > +
> > > +1) Build the installed examples in a generic read/write user directory
> > > +
> > > +Copy to a read/write user directory and just use "make", it will link
> > > +to the libraries on your system, assuming the PKG_CONFIG_PATH is
> > > +correctly configured.
> > > +
> > > +2) Build the examples in-tree
> > > +
> > > +Assuming you're in the doc/example directory of a source FFmpeg
> > 
> >  - you are
> >  - doc/examples
> > 
> > > +checkout, you need to build FFmpeg, no need to make install in any
> > 
> > "assuming you're in the doc/example directory [...] you need to build
> > FFmpeg" doesn't sound right. Possible alternative:
> > 
> > "Assuming you are in the source FFmpeg checkout directory, you need to build
> > FFmpeg (no need to make install in any prefix). Then you can go into the
> > doc/examples and run commands such as PKG_CONFIG_PATH=pc-uninstalled make"
> > 
> > Or something like this.
> > 
> > > +prefix, and set PKG_CONFIG_PATH=pc-uninstalled for make.
> > 
> > Anyway, LGTM, reword at your own discretion and please apply.
> > 
> > Thanks!
> 
> Fixed and applied, thanks.

PKG_CONFIG_PATH=pc-uninstalled make
...
ffmpeg/doc/examples/decoding_encoding.c:457: undefined reference to `avcodec_free_frame'

[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Awnsering whenever a program halts or runs forever is
On a turing machine, in general impossible (turings halting problem).
On any real computer, always possible as a real computer has a finite number
of states N, and will either halt in less than N cycles or never halt.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20121017/2c94c76e/attachment.asc>