From patchwork Sun Jul 5 21:45:45 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manolis Stamatogiannakis X-Patchwork-Id: 20834 Delivered-To: andriy.gelman@gmail.com Received: by 2002:a25:80ca:0:0:0:0:0 with SMTP id c10csp3984276ybm; Sun, 5 Jul 2020 14:47:06 -0700 (PDT) X-Google-Smtp-Source: ABdhPJzjGpdoDrmSxeHzwwjoFQm/yRKGhgPLjaHgJEQsL7qqaWl2GJEUpXKHNWoWwPpx7sJC0d/Z X-Received: by 2002:a1c:5f41:: with SMTP id t62mr4681692wmb.53.1593985626394; Sun, 05 Jul 2020 14:47:06 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1593985626; cv=none; d=google.com; s=arc-20160816; b=fhILNyzAyd6XCOqaGrV3JrhSHGcIrH0NfIiwj1gk4e3hJPLAF36jrKsA10ey2B8qQw 7ffCw+zfyIJXLkjny0S6vwE7vq1woJLaeQlwJi1YVrTeFG5DdzUTMfFP0rqmTXwfQqef 2NBwL+aFuO83AZqD0W1mPukpDxEAUfxo2RjHR6cxET/P5V/9KHL+7r+RiNm3k34crqLF uqZlS1688Fz0EO5Zzv1bX7kGvYln9GT8kGSMcoB5fSJ6Fqode59Xkdco1KUgi52nPw/2 zP0+C1FxZ2y3YI0U2lBeaALr0errzbsw33EZyHRkDV0VVFtCMuxaSsgdftmKU/9YBRZR LaiQ== 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:message-id:date:to:from:dkim-signature :delivered-to; bh=trty3Bgtxrtm6Aisq2Z+A4nf4eZz+DoCol0sxerpcJI=; b=We+t4OJ4RC5IXN5/fW05a+TXf0sysHYsWFnda/bLdZfsvn7C9/8I3c5CE7+I68oEGU lO2MHXQ4NRy9e3NhHNHahgCJpBiX7U0KFE5kxSW76yBv7dOKr1gUyiNvbYjti428h7G2 PZachZqfXcr0+oIZCIQ1J+BFvRABlbGRlfPEl/PXS7v3tWW8w6T2Z6QMM4siWDVFRxhy 4EYrjtcWzPtsJfE7wmQokKhvxFRP+XXPDAVLIiONV2nvCmzVM3L7Vi83rVnenbUQEZBv bklQaWmqputIMWKMuvZ/oQqGyGeZHjD0E99hXPN5DVScw3xnd8RNzNnBO3cMnJvmmVw3 HzHA== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20161025 header.b=KdpiBIeE; 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 y3si16019801wrw.559.2020.07.05.14.47.05; Sun, 05 Jul 2020 14:47:06 -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=KdpiBIeE; 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 24FE268A48B; Mon, 6 Jul 2020 00:47:04 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ej1-f51.google.com (mail-ej1-f51.google.com [209.85.218.51]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id C3235687F97 for ; Mon, 6 Jul 2020 00:46:57 +0300 (EEST) Received: by mail-ej1-f51.google.com with SMTP id o18so36102303eje.7 for ; Sun, 05 Jul 2020 14:46:57 -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; bh=PrmxWtiYYJtmNVdstbuBD/pK5bX6AcnXtGzh93u9Clw=; b=KdpiBIeEUugYSSWG7Fed+4uPh7X0hoNdtTPhqu6uVnZ+t7byy5M44LFOylNeOKCPZ3 gglILfvp3NcdxVrhNA4OPGQeSlu77A7RymKWGgv9S5B7P9W7T3TBA6HDyixAqdTmB8wx DFIyrCHLDup9BJ3vlgdxyyeSSTPlUS2GCHM6sl9YqykSUpRMIugX94ZegyYOteOMZYz6 okej2PjFCA4jIJy4kfh6fT0ejFxH/iGoB+oZnFehwF78lZdrfSdlMdwwaGT97eo9VeN8 A/1uYDxlPNq5AbAip17NZfhcG75rn1PZYy0ZB5pB8tcp1jcUjkm7UY0scOuJKIIWr6ep jmGQ== 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; bh=PrmxWtiYYJtmNVdstbuBD/pK5bX6AcnXtGzh93u9Clw=; b=XvvyXTUFXrF5steFO/cXPBYp2Z50FS0o8g2bRIYWJFUvRfo2KdXtGMoVhkEpFLsNlQ rn6phA2x5eX3yU9YMhbJiuvU/ER4LN163ChLF7OE3/AnrIapg+mNV3gChkb3jZG0KMec zTrkS0sQsohywnXDrcqp0V+7tYCPTDPnnTx9UAaFYZJo7Q4QaEgWvpHDHYUK9pRnj9TJ TYY0VCttjq08dIVhJdfRiDLX+6M55n+sg/MNKNDqw+SQ2b7CEsLR97gDuLgHQjfHdWVy yH/X1ap05WuVN9vB/Zv1ZOjWcW4dK5yGCynEwCOR2siz3YgDiMYe+1hPaHlNEtSqgyEj 2F5Q== X-Gm-Message-State: AOAM532ZLvtDWZKqnFYHxs0KbV/7wgLVXO5iWnKaSBxGSF1ldIm3PeGW E9JVSRibKDo0gYciidAsij/Py/eiTUw= X-Received: by 2002:a17:907:724d:: with SMTP id ds13mr39998656ejc.73.1593985616786; Sun, 05 Jul 2020 14:46:56 -0700 (PDT) Received: from wasteland.vu.local ([145.108.189.179]) by smtp.gmail.com with ESMTPSA id j19sm21691041edt.44.2020.07.05.14.46.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 05 Jul 2020 14:46:56 -0700 (PDT) From: Manolis Stamatogiannakis To: ffmpeg-devel@ffmpeg.org Date: Sun, 5 Jul 2020 23:45:45 +0200 Message-Id: <20200705214547.16485-1-mstamat@gmail.com> X-Mailer: git-send-email 2.17.1 Subject: [FFmpeg-devel] [PATCH v1 1/3] doc/developer.texi: Improvements in Submitting patches section. 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: KuAB3F+otmlx Content-Length: 4649 The section has been expanded to outline how to manage patch revisions. --- doc/developer.texi | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/doc/developer.texi b/doc/developer.texi index b33cab0fc7..dec27cb509 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -491,18 +491,25 @@ as base64-encoded attachments, so your patch is not trashed during transmission. Also ensure the correct mime type is used (text/x-diff or text/x-patch or at least text/plain) and that only one patch is inline or attached per mail. -You can check @url{https://patchwork.ffmpeg.org}, if your patch does not show up, its mime type -likely was wrong. +You can check the most recently received patches on +@url{https://patchwork.ffmpeg.org, patchwork}. +If your patch does not show up, its mime type likely was wrong. -Your patch will be reviewed on the mailing list. You will likely be asked +Your patch will be reviewed on the mailing list. Give us a few days to react. +But if some time passes without reaction, send a reminder by email. +Your patch should eventually be dealt with. However, you will likely be asked to make some changes and are expected to send in an improved version that incorporates the requests from the review. This process may go through several iterations. Once your patch is deemed good enough, some developer will pick it up and commit it to the official FFmpeg tree. -Give us a few days to react. But if some time passes without reaction, -send a reminder by email. Your patch should eventually be dealt with. - +When preparing an updated version of you patch, make sure you increment +its @emph{roll-counter}. This is achieved by adding a @code{-v } argument +to @code{git format-patch}/@code{git send-email} commands. +Additionally, it is recommended to register for a +@uref{https://patchwork.ffmpeg.org, patchwork account}. +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. @chapter New codecs or formats checklist @@ -563,7 +570,19 @@ Did you make sure it compiles standalone, i.e. with Does @code{make fate} pass with the patch applied? @item -Was the patch generated with git format-patch or send-email? +Was the patch generated with @code{git format-patch} or @code{git send-email}? + +@item +If you are submitting a revised patch, did you increment the roll-counter +with @code{-v }? + +@item +If you are submitting a revised patch, did you marked previous versions of +the patch as "Superseded" on @uref{https://patchwork.ffmpeg.org/, patchwork}? + +@item +Are you subscribed to ffmpeg-devel? +(the list is subscribers only due to spam) @item Did you sign-off your patch? (@code{git commit -s}) @@ -576,10 +595,6 @@ Did you provide a clear git commit log message? @item Is the patch against latest FFmpeg git master branch? -@item -Are you subscribed to ffmpeg-devel? -(the list is subscribers only due to spam) - @item Have you checked that the changes are minimal, so that the same cannot be achieved with a smaller patch and/or simpler final code? From patchwork Sun Jul 5 21:45:46 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manolis Stamatogiannakis X-Patchwork-Id: 20835 Delivered-To: andriy.gelman@gmail.com Received: by 2002:a25:80ca:0:0:0:0:0 with SMTP id c10csp3984322ybm; Sun, 5 Jul 2020 14:47:14 -0700 (PDT) X-Google-Smtp-Source: ABdhPJy6t6IoNGl+7I0SCksQJ5ysak0kI22aWmz+tLkr0g07Up61Z/M4WZNGeCcfpN+TTWmhSk9L X-Received: by 2002:a1c:4303:: with SMTP id q3mr48282793wma.134.1593985634713; Sun, 05 Jul 2020 14:47:14 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1593985634; cv=none; d=google.com; s=arc-20160816; b=VjWnBRW9dml/4WT+FaaqnYdjr3YoFuvt6Gx+0dBhApul4X0mwjb+0d3RKXB3PaxlIY zeLuTWvlz7ey+/zCYcJa1WdyRQU+6yGyU7ei5Da+FvM5khIG3QJDlIdEGwcTez+tPuFJ h3SjNvMpZTFWTsaQ31A0FonU6irPDQN93pmiU22bVbSxynDn2YrpaHLR5gv04tGtX2jl C6xbsRBrO9k9CKoMJtUzlI3NvLtFF1PnKZIcT2BFSZYEhrdbHlG9Y/976rEvWErBtSXK RI1Er1WHxOlVrZG6GteTkDuNtVK3vFFbVLJvmq/2kEEY6iGLNAByO0Aj+mO84i/rqoPT Iekw== 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=1yN47gKM4MY6Ng+cKy19vmexiZrs4UT8wWKCVBdtTQY=; b=cz7KQRYj71XB78GP0pSm0dH65Kb6ofuAhU/1bTelk/7Yf+FMu7UlcVq3Xe4q7ImiJE CAL0+dc/qeGy9+kgumRYiDVMzAB2rc8qtSR+SLuNzh47DJhW3GaOnD2/QfkW6ECW+Yij inxfRJfxSmmoHUU0TZVBSdElAsOLYkjpb5QnmmmN+6QpDg8yAhpQVMGb/N/KmizqVNY2 aJJx1/SCppGEOArGJWkBWT+1+WXrcT78uS6KNvWbwH6Cj3bV1CzLRuOnJ2//UwvuueTw lsc/56zEqqdpu4S5lyVSGM4+/EZjqtgdouNHs3i95ErAEzkYCa8SOE4aZUT4/P6FuXLa 6wNg== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20161025 header.b=HAYGeBFs; 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 l11si6639072wrx.381.2020.07.05.14.47.14; Sun, 05 Jul 2020 14:47:14 -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=HAYGeBFs; 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 3C17168A9BB; Mon, 6 Jul 2020 00:47:11 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ed1-f41.google.com (mail-ed1-f41.google.com [209.85.208.41]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 8B54C68A9BB for ; Mon, 6 Jul 2020 00:47:04 +0300 (EEST) Received: by mail-ed1-f41.google.com with SMTP id g20so32887653edm.4 for ; Sun, 05 Jul 2020 14:47:04 -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=dtHUbAs4Yf/JVWb48VX/Lmu0fZ5IXW5m9jvrJJJTfD4=; b=HAYGeBFsFiOzMZD1YoNnd89lr2Eel9kG8fYutEEA1unl7dVYrwcP/w8BOFT6MZPcjX k+6jBWIA+pq8WOGPWc12ZrH7KokMMQTTsMQDYCVurV9Q7ONS28C4gAsgInsRVOSaVC76 CoHs2WY1626vbEA7eHJmp3gtCVB3mARWZpyV5IDUBlqXKrB8tFJoBELhjHb/gyYdQMxE VD/LpqzSvt4h+tFVk0cReN9s3Si3Z1PebD5QWR8Hyys0Ao3E0sfFPBPIA9oMkGdxLLkG 7/Swra/Uq2WzsIEa3uuFVMgvYD3xmp60UD5Z3AscNsNbQC2iMRwLxj57AYB0/hzhxtg9 bmbQ== 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=dtHUbAs4Yf/JVWb48VX/Lmu0fZ5IXW5m9jvrJJJTfD4=; b=QuZiNXbMyRaVoYxjPnRpZ/p+pGy5Y+xh6ZTOFxfBPceXJVTzaOKayEyXHWJ944q+ar ctmHvt9esKjeTDxfEZpndZ78cVKIEo/YT3tlP5OvyEo1JTRpSnCuGHrtBwlJPxwHxay0 0i9tYBwYs5kJYWgrw2n40h+LvCueVKj4ltK7dlS4lxmw3BCGTwv35AJsV5x4Ou9AjnoB xGWiymiiGvLxdTr5b3PUS4hMzucES8NK8tev8gBIXal3xrtlx1EBvGc135RGAM61wozm ovWYrOB1Jq/6UtMyyPU1FCl+mwL0YOESADYpnmzXICpY1MDNGOzTrZeaXEQzHd8ixqAc dbuA== X-Gm-Message-State: AOAM533r1c9jCpr24HjudUMb7Gfqlv2nzL7SDgzIDXaIPQZqVRW6ZmHZ rQA1sI5ZoSBA40c+d9BIXinZ3BwvCyU= X-Received: by 2002:a50:c219:: with SMTP id n25mr53033343edf.306.1593985623538; Sun, 05 Jul 2020 14:47:03 -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.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 05 Jul 2020 14:47:03 -0700 (PDT) From: Manolis Stamatogiannakis To: ffmpeg-devel@ffmpeg.org Date: Sun, 5 Jul 2020 23:45:46 +0200 Message-Id: <20200705214547.16485-2-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 2/3] doc/developer.texi: Restructured Submitting patches section. 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: LF7j9DJ9EDkz Content-Length: 6639 - Main text split to two sections. - Detailed checklist for new codecs or formats demoted to section. - Detailed checklist for patch submission demoted to section. Signed-off-by: Manolis Stamatogiannakis --- doc/developer.texi | 64 +++++++++++++++++++++++++++++++--------------- 1 file changed, 44 insertions(+), 20 deletions(-) diff --git a/doc/developer.texi b/doc/developer.texi index dec27cb509..6d4f6afcf9 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -457,31 +457,49 @@ Finally, keep in mind the immortal words of Bill and Ted, @anchor{Submitting patches} @chapter Submitting patches -First, read the @ref{Coding Rules} above if you did not yet, in particular +@anchor{patch guidelines} +@section Guidelines for preparing a patch + +The @strong{absolute minimum} you have to do before submitting a patch are the +following: + +@enumerate +@item Carefully read the @ref{Coding Rules} above if you did not yet, in particular the rules regarding patch submission. -When you submit your patch, please use @code{git format-patch} or -@code{git send-email}. We cannot read other diffs :-). +@item Make sure your commit messages accurately describe the changes made +(e.g. 'replaces lrint by lrintf') and why these changes are made (e.g. +'*BSD isn't C99 compliant and has no lrint()'). -Also please do not submit a patch which contains several unrelated changes. -Split it into separate, self-contained pieces. This does not mean splitting -file by file. Instead, make the patch as small as possible while still -keeping it as a logical unit that contains an individual change, even -if it spans multiple files. This makes reviewing your patches much easier -for us and greatly increases your chances of getting your patch applied. +@item Make sure you use @code{git format-patch} or @code{git send-email} to prepare +your patch. We cannot read other diffs :-). + +@item Run the @ref{Regression tests, regression tests} before submitting a patch +in order to verify it does not cause unexpected problems. -Use the patcheck tool of FFmpeg to check your patch. -The tool is located in the tools directory. +@item If you send your patches with an external email client +(i.e. not @code{git send-email}), make sure to send each patch as a separate +email. Do not attach several patches to the same email! -Run the @ref{Regression tests} before submitting a patch in order to verify -it does not cause unexpected problems. +@item Do not submit a patch which contains several unrelated changes. +@end enumerate + +Additionally, it is also important that the commits comprising a patch +are logically self-contained. I.e. each commit should be as small as +possible while still containing a meaningful individual change. +Commits spanning multiple files are perfectly fine, as long as the +commit can be seen as a single logical unit. -It also helps quite a bit if you tell us what the patch does (for example -'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant -and has no lrint()') +Following these guidelines makes reviewing your patches much easier +for us and greatly increases your chances of getting your patch applied. +To further reduce the chance that you will need to revise your patch, +it is also recommended to go through the detailed +@ref{patch submission checklist, patch} and +@ref{new codec format checklist, new codec or format} +checklists. -Also please if you send several patches, send each patch as a separate mail, -do not attach several unrelated patches to the same mail. +@anchor{patch submission process} +@section Patch submission and revision process Patches should be posted to the @uref{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel, ffmpeg-devel} @@ -511,7 +529,8 @@ 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. -@chapter New codecs or formats checklist +@anchor{new codec format checklist} +@section New codecs or formats checklist @enumerate @item @@ -563,7 +582,8 @@ Did you make sure it compiles standalone, i.e. with @end enumerate -@chapter Patch submission checklist +@anchor{patch submission checklist} +@section Patch submission checklist @enumerate @item @@ -592,6 +612,10 @@ of @dfn{sign-off}. @item Did you provide a clear git commit log message? +@item +Did you use the @code{patcheck} tool of FFmpeg to check your patch +for common issues? E.g. @code{tools/patcheck *.patch}. + @item Is the patch against latest FFmpeg git master branch? 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