From patchwork Sun Jul 5 21:45:47 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manolis Stamatogiannakis X-Patchwork-Id: 20833 Delivered-To: andriy.gelman@gmail.com Received: by 2002:a25:80ca:0:0:0:0:0 with SMTP id c10csp3984381ybm; Sun, 5 Jul 2020 14:47:24 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxHGT3Kjm2/5WwytO7re+rscWD+0c4KOiGoqneB82e9DPPSVlaU9MTDKDc6Nan5AaiZGeQw X-Received: by 2002:a1c:9a02:: with SMTP id c2mr18124089wme.16.1593985643822; Sun, 05 Jul 2020 14:47:23 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1593985643; cv=none; d=google.com; s=arc-20160816; b=c6F+H1ca2WtvYdQn2w2YUsT2U/bpxSX05T7/zOZrTPZdJyB9dUm+pfdmQgIWvbE4Oq aGuDBxD4rGMHZckY0Qvwbe28I6KUwUx7P9oilVYYWPuRsaflEQtvTA7fJxGSykzgZp+a 03/6YE8EGHHW6rJ4IA6OofPXnTdF3yXIBZ4WlKsIRacQ5GBtkal88XNVGO+IKYBYgJ9Z ZaNMaf8XvfJGRuNITpvd4UInacjnHm2xU6hAYx1hMfqZakbwY4LqBfb9VTqFusiRfZEo fU9+cNmoslxUp/55t6F5wARo7NnbL81JCSxtCMeUJ7X/o8ncQvq3R7kHb40grakK2k1/ V2VA== 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=NevwJvnWH6kTM1smdgM9nL0916RMXm37/mOXh7xtkB8=; b=092YE3d5I6x2p+ISPUOefYmFlGNX+Fq/GzzwxBqJSIeg83SY+raD0alHptgRp53Zfb ZuZdTjc/CX6HuSEocHJtrvKlYa66Qc2lwqXoCnDgmIGaZDyYgeG6WKgluiPZ1GESi0xX Jmxa6PDIm7RxUA4I3/PD+xjfhzxkx6tPcpo8IlsjZrDSsJp0qlRISeiJsi/+7023QVi3 7oe7sDc+Xm95Gc2q287ruX2QQiIqFA5r8/+i401/q2JIuKe7RQt7uxO03nMOnRyftKeX Nrfz+MNDQHPULOuoZ38wSWzzqjr+/H5FKhVpvQNgKyZzuzJSNztHwFpeseMkKjUrT6rb Ukwg== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20161025 header.b=AfJ9P6Wp; 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 203si16699957wme.26.2020.07.05.14.47.23; Sun, 05 Jul 2020 14:47:23 -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=AfJ9P6Wp; 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 2264A68B0EE; Mon, 6 Jul 2020 00:47:13 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ed1-f66.google.com (mail-ed1-f66.google.com [209.85.208.66]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 576EF68AA64 for ; Mon, 6 Jul 2020 00:47:06 +0300 (EEST) Received: by mail-ed1-f66.google.com with SMTP id e15so33090553edr.2 for ; Sun, 05 Jul 2020 14:47:06 -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=DeI5Slp/VIwVPJzSDbtJP2jgf9P6gdBJ84o40fVE/0E=; b=AfJ9P6WpWHnG/9IhCxLcqjAMaOc6/DOlwuuyGMNEI3hMwzqKKWNvuWw/lXC4No6wVX 7Eq1YZ19rhcxNH6HgLmbXiuo3YYrrIJ2KoafJNIJwQrihBXGe+lBDYHA2xy3TSjliXnN glLRqjHjnkXHYI7xE/peKYU9lCelztH8INQxlgLsMKWkFsaA3HJYqDN+9JTfEP751Jus 7UbM+eVCwW/oXqbd1N7KXP+pyb/nQzB4jsT2NyLDXPJlLEolRwTNohirZvxnoe46i2QW og4P0nOv6yYUOfTq3L6qNxZkmcUU32D5bOvQn3ljRZIuqWEg0GdrKsfqVWaGkulWyTsE sz8Q== 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=DeI5Slp/VIwVPJzSDbtJP2jgf9P6gdBJ84o40fVE/0E=; b=TGi3XAKPufygUYyM4OKpF+ufjkJlzIbnoMlPYXYEhNrhgRccNQdOMsKP9Z/3G46Bq2 5NNBrKZU6f9yaDapKZZh6v7ARQ26ltXntHuDXfPR0K4bIGox+4N8wy5lFVxwSxLFlLfm g009FFmfqe337wxjatOXIMEZm+0M74aK0chtdKODc8o7SdHQniwnjgEL+R4zl7MRnUBz S3t67DBkV2ERgTmuKxIahIgTrxSZcwgrnQnW2fLdIG6juLPNOsP1vNzJj+qqsJvY6MFT HSd4EVpFCSKczP1C3AfMhgH8kNWyzvwaDZpl4KLNjqNlQBi6eVoC2MFEwl3sYsEH+VZK U/xg== X-Gm-Message-State: AOAM533xW2/kOdC0XtCmxrt3epwNDCA6D1BuQjVemFsSWxL4/utJK1K+ zGDRlVULvd1EVGFs01Xm5LX0vtoQV4o= X-Received: by 2002:a50:f109:: with SMTP id w9mr50390582edl.277.1593985625401; Sun, 05 Jul 2020 14:47:05 -0700 (PDT) Received: from wasteland.vu.local ([145.108.189.179]) by smtp.gmail.com with ESMTPSA id j19sm21691041edt.44.2020.07.05.14.47.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 05 Jul 2020 14:47:04 -0700 (PDT) From: Manolis Stamatogiannakis To: ffmpeg-devel@ffmpeg.org Date: Sun, 5 Jul 2020 23:45:47 +0200 Message-Id: <20200705214547.16485-3-mstamat@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200705214547.16485-1-mstamat@gmail.com> References: <20200705214547.16485-1-mstamat@gmail.com> Subject: [FFmpeg-devel] [PATCH v1 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: uI+/IrDAracm Content-Length: 5836 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 6d4f6afcf9..cecb10fed1 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -529,59 +529,6 @@ Additionally, it is recommended to register for a This will allow you to mark previous version of your patches as "Superseded", and reduce the chance of someone spending time to review a stale patch. -@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 @@ -708,6 +655,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