From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by master.gitmailbox.com (Postfix) with ESMTP id 88CA444D09 for ; Thu, 17 Nov 2022 10:10:59 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 4F42368BD2B; Thu, 17 Nov 2022 12:10:10 +0200 (EET) Received: from mail0.khirnov.net (red.khirnov.net [176.97.15.12]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id CABDA68BCFF for ; Thu, 17 Nov 2022 12:10:02 +0200 (EET) Received: from localhost (localhost [IPv6:::1]) by mail0.khirnov.net (Postfix) with ESMTP id 9E0F62405EC for ; Thu, 17 Nov 2022 11:09:59 +0100 (CET) Received: from mail0.khirnov.net ([IPv6:::1]) by localhost (mail0.khirnov.net [IPv6:::1]) (amavisd-new, port 10024) with ESMTP id 7nHQ3t9OnnsT for ; Thu, 17 Nov 2022 11:09:58 +0100 (CET) Received: from libav.khirnov.net (libav.khirnov.net [IPv6:2a00:c500:561:201::7]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "libav.khirnov.net", Issuer "smtp.khirnov.net SMTP CA" (verified OK)) by mail0.khirnov.net (Postfix) with ESMTPS id B17282405F9 for ; Thu, 17 Nov 2022 11:09:56 +0100 (CET) Received: from libav.khirnov.net (libav.khirnov.net [IPv6:::1]) by libav.khirnov.net (Postfix) with ESMTP id 4B2E93A0656 for ; Thu, 17 Nov 2022 11:09:50 +0100 (CET) From: Anton Khirnov To: ffmpeg-devel@ffmpeg.org Date: Thu, 17 Nov 2022 11:09:42 +0100 Message-Id: <20221117100942.6217-7-anton@khirnov.net> X-Mailer: git-send-email 2.35.1 In-Reply-To: <20221117100942.6217-1-anton@khirnov.net> References: <20221117100942.6217-1-anton@khirnov.net> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH 7/7] doc/developer.texi: extend and update naming conventions X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: FFmpeg development discussions and patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: FFmpeg development discussions and patches Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Archived-At: List-Archive: List-Post: Bring it up to date with current practice, as the current text does not cover everything. Drop the reference to unprefixed exported symbols, which do not exist anymore. --- doc/developer.texi | 43 +++++++++++++++++++++++++++---------------- 1 file changed, 27 insertions(+), 16 deletions(-) diff --git a/doc/developer.texi b/doc/developer.texi index a2719e7518..48c27f3005 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -191,39 +191,50 @@ int myfunc(int my_parameter) @end example @section Naming conventions -All names should be composed with underscores (_), not CamelCase. For example, -@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 CamelCase. -There are the following conventions for naming variables and functions: +Names of functions, variables, and struct members must be lowercase, using +underscores (_) to separate words. For example, @samp{avfilter_get_video_buffer} +is an acceptable function name and @samp{AVFilterGetVideo} is not. -@itemize @bullet -@item -For local variables no prefix is required. +Struct, union, enum, and typedeffed type names must use CamelCase. All structs +and unions should be typedeffed to the same name as the struct/union tag, e.g. +@code{typedef struct AVFoo @{ ... @} AVFoo;}. Enums are typically not +typedeffed. +Enumeration constants and macros must be UPPERCASE, except for macros +masquerading as functions, which should use the function naming convention. + +All identifiers in the libraries should be namespaced as follows: +@itemize @bullet @item -For file-scope variables and functions declared as @code{static}, no prefix -is required. +No namespacing for identifiers with file and lower scope (e.g. local variables, +static functions), and struct and union members, @item -For variables and functions visible outside of file scope, but only used -internally by a library, an @code{ff_} prefix should be used, -e.g. @samp{ff_w64_demuxer}. +The @code{ff_} prefix must be used for variables and functions visible outside +of file scope, but only used internally within a single library, e.g. +@samp{ff_w64_demuxer}. This prevents name collisions when FFmpeg is statically +linked. @item For variables and functions visible outside of file scope, used internally across multiple libraries, use @code{avpriv_} as prefix, for example, @samp{avpriv_report_missing_feature}. +@item +All other internal identifiers, like private type or macro names, should be +namespaced only to avoid possible internal conflicts. E.g. @code{H264_NAL_SPS} +vs. @code{HEVC_NAL_SPS}. + @item 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/lib.v} files. + +@item +Other public identifiers (struct, union, enum, macro, type names) must use their +library's public prefix (@code{AV}, @code{Sws}, or @code{Swr}). @end itemize Furthermore, name space reserved for the system should not be invaded. -- 2.35.1 _______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".