From patchwork Sun Jul 12 21:53:01 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manolis Stamatogiannakis X-Patchwork-Id: 20982 Delivered-To: andriy.gelman@gmail.com Received: by 2002:a25:80ca:0:0:0:0:0 with SMTP id c10csp2185656ybm; Sun, 12 Jul 2020 15:01:01 -0700 (PDT) X-Google-Smtp-Source: ABdhPJy5BTb55iVn/fwlsi6aj9hzkJOj8nj2FpZqJYRZgiiw6btda+DTto3Fh9rYzlSYTmYyKVZo X-Received: by 2002:a1c:acc3:: with SMTP id v186mr16686655wme.79.1594591261772; Sun, 12 Jul 2020 15:01:01 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1594591261; cv=none; d=google.com; s=arc-20160816; b=muOZ50Az3DjSue8cUB0jStj9b+eFdxkROpXtLN7zO/Lb6TLAU3eYQEcYvzKOXpamTP HVtQSacXdPG82qsL4kqMk92UD7qn/Gxjkff+8IQS7H7cuB0anlyznogtP5Shz2WBvpy1 2CCWProAXyaWPD3BElkFWMguNcHA/8MCCfQk1CqxsTxjzHWSDa871KwoXl60seMHcG3V cGwy75o2aNXc6haF0ljBpiKa0aGbHuAEgnYypyAXwkrmb6TorsNhBk/NvFMMdwfDazZv Xql9ldwLyPmSBe/TxBC52KtbklaANXXudnQLb0E2lCV9RytCoSyq9jlclqIaszbZDZPh u50Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:mime-version:cc:reply-to :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:references:in-reply-to:message-id:date :to:from:dkim-signature:delivered-to; bh=jgv2VISK2mT4n+fejbe5mQb17PbuQqn3mxrGPyqfcR0=; b=0CBUHye5k+DR+XE4t5RARFwDIamfSOxQ7vl5YuxYE59mMKFrdy4KeVy7Qg5dE3TqGG grRB2VdBmP9rXpAPrpr6HzTWMQo1O50NnAN6CLurDXFBHam/e9Htx0heYJOVfnjObFzi oUYTbqEorg9OH5n54RMr5YXG32Dp7FgB97/PYqeo5xTxoaXJbS/+HD0Qda6L63cj5qx9 Pl/eo1JFtGjN7ePXCZ4hp5PJtik7FUqbyWb4mIXtOXomYhLb37H/W1IoLsKU0Ov9IXR6 +UMHI+fJ2j92yugo4ahpx05djgdNoaL2cZRndFmL1IgE6dIKdwcBSw87xTb0bBPeEFDn udbQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20161025 header.b="FFAd/mB5"; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id u23si10217960wmm.155.2020.07.12.15.01.01; Sun, 12 Jul 2020 15:01:01 -0700 (PDT) Received-SPF: pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) client-ip=79.124.17.100; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20161025 header.b="FFAd/mB5"; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id C7C8468A857; Mon, 13 Jul 2020 01:00:59 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ej1-f49.google.com (mail-ej1-f49.google.com [209.85.218.49]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 65CE3680A7C for ; Mon, 13 Jul 2020 01:00:53 +0300 (EEST) Received: by mail-ej1-f49.google.com with SMTP id a1so13107383ejg.12 for ; Sun, 12 Jul 2020 15:00:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=CICZctmrcsyDxLv1O14BqKvk5pvIuZspt7saJuCTKys=; b=FFAd/mB5RW6SxV6FgU1wjyDgYWvpL/2Zz/8dvZ0ymFaiw+SY+uIlEYEItjGp2xwaR4 TX8aVMR5KBNo2CNpMqVDPX+Nh1XKlJEUqvIsqlsbw+6/Id6jTGx5vgrxF4xh1HOfWfPY oeepMDCACBRCzIdqn6Cg4qeELmRI/JJ//e+GS7QhwC6WUGucTqcGgt41bh4rI4Yqhsbs tGTKD3V/PkcSjz+1Op4iWWYqaSusFAL5HAzOBwkrawl/xEAYdJGfzgkMb81rh9Meniug 1qA2Gpdf+1w8X+/gP6MusYcT++l0oYHXpDQBapd6opLZSYSfvVLf/Em9vZIxc0jBB9ux GG+Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=CICZctmrcsyDxLv1O14BqKvk5pvIuZspt7saJuCTKys=; b=iNkmSVCzjC+GDIHddORSYrCE9+EYRin75cshwcNoHzhF3n7WevQTj7VRQTnFOAUFKU wwVS0CLJwcAjITTavtJEcHxqQnvZssRSSh3ZMPUMg98b00M7pfyKS1lxvV+jYzKMw2L5 QOnKMK9eKdLfYxtaAnIVJ8q+8jCv6gPH4kE4b7wVsCkHIcEdk22eoMnMdcvcRfYni9NX 75yCQXO9U4dRa1zGzOEXELntX8HQQr1IJeBrKwigTheKJUXqdoj/9TtjSUKLCsk4gerI x+U9x+hlEepbjXapvsPCeKGKrJlQVub+EmaXirMzdsyZ+P/erWZ4VFD+u4uleozN9JSs je8g== X-Gm-Message-State: AOAM5339yudI4aQzTJc93hSDvGh9vdsdFN7dlJ57c0bWSxfG7onGaWE5 Kx4UfwcIhoq3KzeWFcElRs8Puk/63JKjSg== X-Received: by 2002:aa7:d8c2:: with SMTP id k2mr86646663eds.346.1594590813855; Sun, 12 Jul 2020 14:53:33 -0700 (PDT) Received: from wasteland.vu.local ([145.108.189.179]) by smtp.gmail.com with ESMTPSA id p4sm8464076eji.123.2020.07.12.14.53.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 12 Jul 2020 14:53:33 -0700 (PDT) From: Manolis Stamatogiannakis To: ffmpeg-devel@ffmpeg.org Date: Sun, 12 Jul 2020 23:53:01 +0200 Message-Id: <20200712215301.24889-3-mstamat@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200712215301.24889-1-mstamat@gmail.com> References: <20200712215301.24889-1-mstamat@gmail.com> Subject: [FFmpeg-devel] [PATCH v2 3/3] doc/developer.texi: Swapped patch checklist and new codec/format checklist. X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.20 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 Cc: Manolis Stamatogiannakis MIME-Version: 1.0 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: UnEAC5h1fSwR Content-Length: 5861 Adding a new codec/format should be more rare, so it makes sense to come after the detailed patch submission checklist. Signed-off-by: Manolis Stamatogiannakis --- doc/developer.texi | 105 ++++++++++++++++++++++----------------------- 1 file changed, 52 insertions(+), 53 deletions(-) diff --git a/doc/developer.texi b/doc/developer.texi index c47d23e349..c482c5e09d 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -535,59 +535,6 @@ its @emph{roll-counter}. This is achieved by adding a @code{-v } argument to @code{git format-patch}/@code{git send-email} commands. While this is not a strict requirement, it is a commonly followed good practice. -@anchor{new codec format checklist} -@section New codecs or formats checklist - -@enumerate -@item -Did you use av_cold for codec initialization and close functions? - -@item -Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or -AVInputFormat/AVOutputFormat struct? - -@item -Did you bump the minor version number (and reset the micro version -number) in @file{libavcodec/version.h} or @file{libavformat/version.h}? - -@item -Did you register it in @file{allcodecs.c} or @file{allformats.c}? - -@item -Did you add the AVCodecID to @file{avcodec.h}? -When adding new codec IDs, also add an entry to the codec descriptor -list in @file{libavcodec/codec_desc.c}. - -@item -If it has a FourCC, did you add it to @file{libavformat/riff.c}, -even if it is only a decoder? - -@item -Did you add a rule to compile the appropriate files in the Makefile? -Remember to do this even if you're just adding a format to a file that is -already being compiled by some other rule, like a raw demuxer. - -@item -Did you add an entry to the table of supported formats or codecs in -@file{doc/general.texi}? - -@item -Did you add an entry in the Changelog? - -@item -If it depends on a parser or a library, did you add that dependency in -configure? - -@item -Did you @code{git add} the appropriate files before committing? - -@item -Did you make sure it compiles standalone, i.e. with -@code{configure --disable-everything --enable-decoder=foo} -(or @code{--enable-demuxer} or whatever your component is)? -@end enumerate - - @anchor{patch submission checklist} @section Patch submission checklist @@ -710,6 +657,58 @@ Test your code with valgrind and or Address Sanitizer to ensure it's free of leaks, out of array accesses, etc. @end enumerate +@anchor{new codec format checklist} +@section New codecs or formats checklist + +@enumerate +@item +Did you use av_cold for codec initialization and close functions? + +@item +Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or +AVInputFormat/AVOutputFormat struct? + +@item +Did you bump the minor version number (and reset the micro version +number) in @file{libavcodec/version.h} or @file{libavformat/version.h}? + +@item +Did you register it in @file{allcodecs.c} or @file{allformats.c}? + +@item +Did you add the AVCodecID to @file{avcodec.h}? +When adding new codec IDs, also add an entry to the codec descriptor +list in @file{libavcodec/codec_desc.c}. + +@item +If it has a FourCC, did you add it to @file{libavformat/riff.c}, +even if it is only a decoder? + +@item +Did you add a rule to compile the appropriate files in the Makefile? +Remember to do this even if you're just adding a format to a file that is +already being compiled by some other rule, like a raw demuxer. + +@item +Did you add an entry to the table of supported formats or codecs in +@file{doc/general.texi}? + +@item +Did you add an entry in the Changelog? + +@item +If it depends on a parser or a library, did you add that dependency in +configure? + +@item +Did you @code{git add} the appropriate files before committing? + +@item +Did you make sure it compiles standalone, i.e. with +@code{configure --disable-everything --enable-decoder=foo} +(or @code{--enable-demuxer} or whatever your component is)? +@end enumerate + @chapter Patch review process All patches posted to ffmpeg-devel will be reviewed, unless they contain a