1
0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2025-01-24 13:56:33 +02:00

Merge commit '56dea32f09e71460add14a1b6d0fbe6eb16f02a4'

* commit '56dea32f09e71460add14a1b6d0fbe6eb16f02a4':
  doc: developer: Fix wording in "naming conventions" section
  openbsd: Add minor number to shared library install name

Conflicts:
	doc/developer.texi

Merged-by: Michael Niedermayer <michaelni@gmx.at>
This commit is contained in:
Michael Niedermayer 2013-02-12 13:41:24 +01:00
commit 08db519e12
2 changed files with 10 additions and 11 deletions

2
configure vendored
View File

@ -3162,7 +3162,7 @@ case $target_os in
openbsd|bitrig) openbsd|bitrig)
disable symver disable symver
SHFLAGS='-shared' SHFLAGS='-shared'
SLIBNAME_WITH_MAJOR='$(SLIBNAME).$(LIBVERSION)' SLIB_INSTALL_NAME='$(SLIBNAME).$(LIBMAJOR).$(LIBMINOR)'
SLIB_INSTALL_LINKS= SLIB_INSTALL_LINKS=
oss_indev_extralibs="-lossaudio" oss_indev_extralibs="-lossaudio"
oss_outdev_extralibs="-lossaudio" oss_outdev_extralibs="-lossaudio"

View File

@ -147,27 +147,26 @@ GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
@end itemize @end itemize
@subsection Naming conventions @subsection Naming conventions
All names are using underscores (_), not CamelCase. For example, @samp{avfilter_get_video_buffer} is All names should be composed with underscores (_), not CamelCase. For example,
a valid function name and @samp{AVFilterGetVideo} is not. The exception from this are type names, like @samp{avfilter_get_video_buffer} is an acceptable function name and
@samp{AVFilterGetVideo} is not. The exception from this are type names, like
for example structs and enums; they should always be in the CamelCase for example structs and enums; they should always be in the CamelCase
There are the following conventions for naming variables and functions:
There are following conventions for naming variables and functions:
@itemize @bullet @itemize @bullet
@item @item
For local variables no prefix is required. For local variables no prefix is required.
@item @item
For variables and functions declared as @code{static} no prefixes are required. For variables and functions declared as @code{static} no prefix is required.
@item @item
For variables and functions used internally by the library, @code{ff_} prefix For variables and functions used internally by a library an @code{ff_}
should be used. prefix should be used, e.g. @samp{ff_w64_demuxer}.
For example, @samp{ff_w64_demuxer}.
@item @item
For variables and functions used internally across multiple libraries, use For variables and functions used internally across multiple libraries, use
@code{avpriv_}. For example, @samp{avpriv_aac_parse_header}. @code{avpriv_}. For example, @samp{avpriv_aac_parse_header}.
@item @item
For exported names, each library has its own prefixes. Just check the existing For externally visible symbols, each library has its own prefix. Check
code and name accordingly. the existing code and choose names accordingly.
@end itemize @end itemize
@subsection Miscellaneous conventions @subsection Miscellaneous conventions