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?