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?