From patchwork Sun Jul 12 21:52:59 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manolis Stamatogiannakis X-Patchwork-Id: 20984 Delivered-To: andriy.gelman@gmail.com Received: by 2002:a25:80ca:0:0:0:0:0 with SMTP id c10csp2192870ybm; Sun, 12 Jul 2020 15:15:59 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyIgIFr3hCvF1GbLRmro/8abEHpDKdue8R5LVYOYyksfgbBgqKbEYSwUSGqQqNESclpj5+9 X-Received: by 2002:a1c:2349:: with SMTP id j70mr15700214wmj.22.1594592159466; Sun, 12 Jul 2020 15:15:59 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1594592159; cv=none; d=google.com; s=arc-20160816; b=XIGNQ7NFIqwkR87hS5K76nobbMi9GbFHy4nWWDuWX+hIxJmFcCRBbCtE+qXYBSNnE4 Dr8qA+6XtAsMLiL1vF2XbMcdzVQWIQZhs5qcV9oRWXmoTaM3xeVLqf7zQoklz50XxEct REHmOlgL9btVs8ZDLsBTOdUe5dHQMIza1wbcXJ4NIpUcEE/Bm6xtes93b0J/qyRVSh32 yYGtnKeYepszwA1RHJK4cJTnPcKU2JcWLFLxtGI4HTjYwwbpKdDs5hINuRFIFZVfT9Jo iMWTBoG4u5dcyM3L/rxkU+Gfxvk2NxooVaj2LItmoXTadH3jezfj5AClTIIsN74/vdoY LXCQ== 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=G+LGas9QRPzE8emFwl+fJvMp1fBBMjM9tdn1hyVzf2g=; b=BoxMFBxTTEaLd3nrvSCth9uC1Zoj7r5UXKnKsGuWWcdKbaTPZp+p7l23cY0D9HIIk1 k0m0PaNVjcGapB7ZejMrWKpGIOgRudnuizp54WDhz1I8hysUUKyd25vjQAx5rI4uewWC P2ptYzfhCaCWnfZnAGM0cfFDRZqzZz2fpcdm56T1mRRCklK1b/MfJMFKYLD/oTMC/wLQ ZAnhLHIsR/hc3/4SFI1AhMvYpbW/JACgJ4H14AZ4aQpNC7NXgFro1iX3SLjTnRar0zf/ yy1L/8ag7mYWavchqaweXaWWLQx3tHsyiLCkfgcU8VoL4FSIheSkKsqREoiWBahJAidf 2zLA== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20161025 header.b=X8aqkPUO; 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 h9si10926762wme.115.2020.07.12.15.15.58; Sun, 12 Jul 2020 15:15:59 -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=X8aqkPUO; 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 8D6CF68A353; Mon, 13 Jul 2020 01:15:55 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ed1-f67.google.com (mail-ed1-f67.google.com [209.85.208.67]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 35A096882FB for ; Mon, 13 Jul 2020 01:15:48 +0300 (EEST) Received: by mail-ed1-f67.google.com with SMTP id d18so10239707edv.6 for ; Sun, 12 Jul 2020 15:15:48 -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=GgUBrYYmtvQRbfH/HZXC1t2p3jx+xafYBd7ByZCpvZY=; b=X8aqkPUOFkaLs4sHWPJVXK3GGD6A6J+phoXUqQaBG9GPon4EDh3Cr2JL2PzYmxm+PD 9PdEBsBrL2drC5lLfDR+jQybMu7J6CifJYffOnJHRwHKJ2lZkR+NCJJmV6cMkdmkFCnr 2M7LpqSz/iNBW/oxXXWjmE1I5UyiMsWzK+fI/vZVIaEjZ0YRhNIhxd3pKdHzZiBAAxRL Xydt78F4ipWkCUwuBCvpgEoYbbcs6xDV0y5HdtzfVALagAB710uNqMBMPne5eeqjkh5F SgibchOsmU2E1sjao8MvlM3NO6qkwoe3wXqfAGeATOSHzPtPZ7hL+j7X7/GbW3yXDp6T 2loA== 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=GgUBrYYmtvQRbfH/HZXC1t2p3jx+xafYBd7ByZCpvZY=; b=Rxgwg5wEjdE9LDRnBCRcL3rpe4SQXNbBct3fydMDWxCtEu1RolJLrwSSpq1ZuNfLzg D6Sh7X30Szi/kde2Q6beyBJSgK4EHgkgy+8fNiF2EUoi+BbITcGu/jTFLmXSZtXooZc/ ExmChordmdHXbe6RP4lic+YTA3NnE0tXFSWutzIGU9MYXnZFO2ljc2LFKL1hCbjNNzlo WkpC8J5+dVwJ1Qia3YobZI5kER46CL7MD8FuV0DayRAdxqZVpHzpF88n5UX0T6auOWXA jyYIqDEo0cLjo+W43Pu9Fr3ddGqrmaiSoFyWAOmRzAFJnWEai3ng73wHGp+AF+nrYf8z nvvA== X-Gm-Message-State: AOAM532uh8tNxIy+OZ/HyEvWDrYPkFImjvhBB6otb1yt/5u6rAFxdMl/ TW49xoTDs6klkx03bejCprFJewhS3BF31A== X-Received: by 2002:a50:c219:: with SMTP id n25mr89438247edf.306.1594590806717; Sun, 12 Jul 2020 14:53:26 -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.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 12 Jul 2020 14:53:26 -0700 (PDT) From: Manolis Stamatogiannakis To: ffmpeg-devel@ffmpeg.org Date: Sun, 12 Jul 2020 23:52:59 +0200 Message-Id: <20200712215301.24889-1-mstamat@gmail.com> X-Mailer: git-send-email 2.17.1 Subject: [FFmpeg-devel] [PATCH v2 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: Kix+miwf341g Content-Length: 5050 - Documentation for adding a roll-counter. - Mention the possibility to manualy supersede/withdraw patches on patchwork. Signed-off-by: Manolis Stamatogiannakis --- doc/developer.texi | 41 +++++++++++++++++++++++++++++------------ 1 file changed, 29 insertions(+), 12 deletions(-) diff --git a/doc/developer.texi b/doc/developer.texi index b33cab0fc7..585c37d241 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -491,18 +491,31 @@ 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. - -Your patch will be reviewed on the mailing list. You will likely be asked +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. + +If you need to manually manage your patch (e.g. urgently mark it as as +"Superseded", or "Withdrawn") you can do so by +@uref{https://patchwork.ffmpeg.org/register/, registering for a patchwork account}. +Note that this is not generally required, as patch management on patchwork +is largely automated. But there are case where manual patch management is +desired. For example, if you have started working on extensive changes +on your patch, and you don't want people to spend more time reviewing the +old version. + +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, you should increment +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. @chapter New codecs or formats checklist @@ -563,7 +576,15 @@ 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 +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 +597,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 12 21:53:00 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manolis Stamatogiannakis X-Patchwork-Id: 20983 Delivered-To: andriy.gelman@gmail.com Received: by 2002:a25:80ca:0:0:0:0:0 with SMTP id c10csp2182974ybm; Sun, 12 Jul 2020 14:53:46 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyOPFAufPZZdR3tb9QB7yL2TX0JhQIomR9e5Tm75Vf9oeW7caNYy540qQwmktW5hNCGVykk X-Received: by 2002:a1c:ed0b:: with SMTP id l11mr15859287wmh.121.1594590826117; Sun, 12 Jul 2020 14:53:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1594590826; cv=none; d=google.com; s=arc-20160816; b=PUgnSxgFtUtiZzjgr+dxc5rgF2XXr2trjAKIPIjeuGcMxsLS/nTjK3GJqA4D5zz8RT y6MvLhrdQvcZfiUm1lFmSwPHvOqckiLVdMRJOMqeay6gHoNv3WLCViInungelA1L76lY QVdL7GV19R2r+wpng8+BOn30HXYz5PY+x89BjO4j4DuoIMpZ1YGyrdD7DXlewK5hs/dm JQ5pRsQ0iJSZLKsHVGsjhZaJ2d5zgzy0ocd0y75Q/RQj1RayREcPgS8gSrA6wXXEFDyQ HkUgwg1gUXIqVq2j1rVjTKsBv2o6Fb5UPO+9Q999jwJEl/qOS6MXTGoySYd4szlCDWlN G+Ew== 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=qRtQEsFESXYnbevwi1uyidPKukagFoZ8g1kryxtTMlU=; b=NoW2uwtnuKutjJTQxqEln5duv2y7ZDN4GBwwqtRWabcSHbMm4peSXxzxynzOf1ShDE 1Q4Py/BHsfzxK1buPoPocSBPvUiKFHEi+0ba3solPgWXla+3ScMO7rzYkWTsV2V1tcKy IhWOolVGPWHqyUh0JSnsEqk3qIKI1QmYsCpoC1TKMl1ZkIKox/DJgOT/2V5nh5zvNd+E T78glw2SJwBrLzJFC2liYRXuEAPwS8TAx5Anzk74w7et+6t3HjiMU0f8vapAMhLXjqg0 ARgKt2hs2E8WO9kaF/QtJAgUpMObAzP7clM7ESO+lASoK53ZZLFgYbS15v5kVQKYOPxd tcMA== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20161025 header.b=uFLQUqMQ; 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 p12si10284034wmc.170.2020.07.12.14.53.44; Sun, 12 Jul 2020 14:53:46 -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=uFLQUqMQ; 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 85D0A68A383; Mon, 13 Jul 2020 00:53:39 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ed1-f52.google.com (mail-ed1-f52.google.com [209.85.208.52]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id D3B3B68A383 for ; Mon, 13 Jul 2020 00:53:32 +0300 (EEST) Received: by mail-ed1-f52.google.com with SMTP id d16so10160809edz.12 for ; Sun, 12 Jul 2020 14:53:32 -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=K6Na3M//Qog/lvHChfp/bXrh1aLPbjjI5i2CVIQ3VwQ=; b=uFLQUqMQJPhrZaMBQ00RTv/Yer+Gq9JYoEQR2rEEHdOMp4EEV6UDP+6/4jh8xhsIup U28FB0T0DxZLRAhIReFHXaPlDRFOG/7FGsEjYHnuing0XQnywepane9VRSdzuAyXNU31 ojQQE8UCTEhRLGN3keVkrkpfDSNInnQJq070h3Q5oKGTsq3b/rFnKdfYQysUfvo/Hh2N 3ZlZ3dBc+AFOkPjtA/+PUS1YjT6dqquHvX5Tne1jgnSuLka8wTdMfR9lhfwuZHJc2lyj b0JEjtpj/As9tiO+mlQcwI0egWqq7fxREy/MKF6XD27n4vA2hHXmubfSIGknxs5XSMOT ynWQ== 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=K6Na3M//Qog/lvHChfp/bXrh1aLPbjjI5i2CVIQ3VwQ=; b=JGbKPeiJknTZ5bq3+5rS9IapNr8YIkSHtcv1DG/vPAfRHJfnnYx0RBuMjkC8IrhDHR csUW3QXQpnOE9FAARoS13PHIPr0+GjnPhl3WmV555jh0Xm7LxcZxsqQIrUlY2fQ3ISRR wImvSxdBHWAiIVvTjtLief+snJbUO3Ts6ONDvVWQhc1czfdHGAZ/KK7WPu/YZjls/0XS Po3sc6ImM0QWoZCDn1E24mkxHL4nAweeU3Yh/JGv05ThJOIwId2Q/8vrAR2Oqp9RPJk2 xhl/PJP0QyrytdU/MIzPs/Mj1JSW4vUhJH9Eah9bYlu+Da0PzmwYsgXApJVXyJjfCFeq M0vQ== X-Gm-Message-State: AOAM532AYFpO0eHUeZyXMsSqQ25b1Kam+OY3J3LCPzT89oaFACf2MKMv 3QZuJB22PCnbY9bgp7k1B4h+WJEFhYCR0A== X-Received: by 2002:a05:6402:180a:: with SMTP id g10mr77531468edy.152.1594590811763; Sun, 12 Jul 2020 14:53:31 -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.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 12 Jul 2020 14:53:31 -0700 (PDT) From: Manolis Stamatogiannakis To: ffmpeg-devel@ffmpeg.org Date: Sun, 12 Jul 2020 23:53:00 +0200 Message-Id: <20200712215301.24889-2-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 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: Pj5eBGvmitJ6 Content-Length: 6627 - 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 585c37d241..c47d23e349 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 each patch is logically +self-contained. I.e. each patch should be as small as possible, +while still containing a meaningful individual change. +Patches spanning multiple files are perfectly fine, as long as they 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} @@ -517,7 +535,8 @@ 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. -@chapter New codecs or formats checklist +@anchor{new codec format checklist} +@section New codecs or formats checklist @enumerate @item @@ -569,7 +588,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 @@ -594,6 +614,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 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