[FFmpeg-devel] [PATCH] Implement common show_banner and show_version functions

[Stefano Sabatini]

On date Tuesday 2007-09-25 20:45:09 +0200, Benoit Fouet encoded:
> Hi,
> 
> Stefano Sabatini wrote:
[...]
> > Index: cmdutils.h
> > ===================================================================
> > --- cmdutils.h	(revision 10573)
> > +++ cmdutils.h	(working copy)
> > @@ -65,6 +65,23 @@
> >  void print_error(const char *filename, int err);
> >  
> >  /**
> > + * Prints the banner of the program on stderr. The banner message
> > + * depends on the current versions of the repository and of the libav*
> > + * libraries.
> > + * @param program_name The name of the program.
> > + * @param program_birth_year The year of birth of the program.
> >   
> 
> i would neither capitalize the "T" nor use period.
> english/doc experts ?

I'm not and english expert, but I think:
@param program_name Name of the program.

is both more correct and consistent with other documentation.

For what regards the punctuation: there isn't a consistent style
throughout the FFmpeg docs, but Diego seems to favour this:
@param foo Value of the fooness factor.

so I'm going with it. 

[...]
> > + */
> > +void show_version(const char *program_name);
> > +
> > +/**
> >   * Prints on stdout the license of the program, which depends on the license of
> >   * the compiled libav* libraries.
> >   */
> > Index: ffmpeg.c
> > ===================================================================
> > --- ffmpeg.c	(revision 10573)
> > +++ ffmpeg.c	(working copy)
> > @@ -63,6 +63,9 @@
> >  
> >  #undef exit
> >  
> > +static const char *program_name = "FFmpeg";
>
> i'd say static const char program_name[]

As you wish ;-)
 
> > +static const int program_birth_year = 2000;
> > +
> >  /* select an input stream for an output stream */
> >  typedef struct AVStreamMap {
> >      int file_index;
> > Index: ffserver.c
> > ===================================================================
> > --- ffserver.c	(revision 10573)
> > +++ ffserver.c	(working copy)
> > @@ -53,6 +53,9 @@
> >  
> >  #undef exit
> >  
> > +static const char *program_name = "FFserver";
> >   
> 
> ditto
[...]

Regards.
-- 
Stefano Sabatini
Linux user number 337176 (see http://counter.li.org)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: implement-common-show-version-and-banner-05.patch
Type: text/x-diff
Size: 5250 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20070925/fb6170ae/attachment.patch>