[FFmpeg-devel] [PATCH 1/2] doc: do not generate doc/avoptions_(codecs|formats).texi

[Michael Niedermayer]

On Sun, Sep 15, 2013 at 11:51:37AM +0200, Stefano Sabatini wrote:
> On date Tuesday 2013-09-10 18:52:54 +0200, Michael Niedermayer encoded:
> > On Mon, Sep 09, 2013 at 09:56:08AM +0200, Stefano Sabatini wrote:
> [...]
> > > > diff --git a/.gitignore b/.gitignore
> > > > index 1f13ec4..807ecb1 100644
> > > > --- a/.gitignore
> > > > +++ b/.gitignore
> > > > @@ -33,8 +33,6 @@
> > > >  /doc/*.html
> > > >  /doc/*.pod
> > > >  /doc/config.texi
> > > > -/doc/avoptions_codec.texi
> > > > -/doc/avoptions_format.texi
> > > >  /doc/examples/decoding_encoding
> > > >  /doc/examples/demuxing
> > > >  /doc/examples/filtering_audio
> > > > diff --git a/doc/Makefile b/doc/Makefile
> > > > index 7415899..cfd2ca5 100644
> > > > --- a/doc/Makefile
> > > > +++ b/doc/Makefile
> > > > @@ -50,13 +50,6 @@ doc/%.txt: doc/%.texi
> > > >  	$(Q)$(TEXIDEP)
> > > >  	$(M)makeinfo --force --no-headers -o $@ $< 2>/dev/null
> > > >  
> > > > -GENTEXI  = format codec
> > > > -GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
> > > > -
> > > > -$(GENTEXI): TAG = GENTEXI
> > > > -$(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
> > > > -	$(M)doc/print_options $* > $@
> > > > -
> > > >  doc/%.html: TAG = HTML
> > > >  doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
> > > >  	$(Q)$(TEXIDEP)
> > > 
> > > I suppose it's OK. I suggest to keep the generating program for
> > > easing merges.
> > 
> > if the programs are kept, code to build and test them should be kept
> > too.
> 

> > Also are our handwritten files complete and uptodate compared to the
> > autobuild ones ?
> 
> We do an effort to keep them updated, but of course there is no
> automated way to keep them updated/synched with the descriptions
> (that's why we should add documentation when adding options).

I belive that who objects to the automated system has to do the work
that not using it causes.

In practice id say
That involves at least keeping track of changes of the automated
output and integrating them. That way its also always known if or what
is missing.


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

When you are offended at any man's fault, turn to yourself and study your
own failings. Then you will forget your anger. -- Epictetus
-------------- 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/20130915/2aaf6cd2/attachment.asc>