From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by master.gitmailbox.com (Postfix) with ESMTP id 392E74710F for ; Sun, 27 Aug 2023 12:46:46 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id C959668C519; Sun, 27 Aug 2023 15:46:43 +0300 (EEST) Received: from mail-lj1-f176.google.com (mail-lj1-f176.google.com [209.85.208.176]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id DB00868BBC6 for ; Sun, 27 Aug 2023 15:46:37 +0300 (EEST) Received: by mail-lj1-f176.google.com with SMTP id 38308e7fff4ca-2bccda76fb1so35562481fa.2 for ; Sun, 27 Aug 2023 05:46:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1693140396; x=1693745196; h=to:subject:message-id:date:from:in-reply-to:references:mime-version :from:to:cc:subject:date:message-id:reply-to; bh=3QCNcQnJPM+1YjZEnstNjxzhipLiLC1vi6h7bRTEkLE=; b=cY2QNfENmrG8m/FOumTo/R/WWNOnSrwNgIFFwS7LA95fp3gynHCWl3MjpC/q0ISHoU oXgfG+BIShQZ6SqYFUuBzwlZT1ytKZ/i9RiW6M2LuXGMGbgYw+GfNipc6+DN7KnfOtrU dkRs0pSVmUhCcPK+3k2vsHjk9JJ1tsV0LBS5rvXTBbAo0hdL71zHDXNfkb1QUXAV51JS nCO4x349KCb9dCRdkS5nSichjRLwvp73ObYabnCfDe3EEm7HbC8rJLTrmQShE2pouCqO toz3TyoOFBoObRd//MjsqYHA2FRKH4WVzaGMSWGvj6vLf68gc7rccUJih6fxE2DaPsiC BQ/A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1693140396; x=1693745196; h=to:subject:message-id:date:from:in-reply-to:references:mime-version :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=3QCNcQnJPM+1YjZEnstNjxzhipLiLC1vi6h7bRTEkLE=; b=icY4lBnj0ag/RGFMQff7lKOaqnIrHyemdfh64iKAAVTamr8PYe54zqvBKtmvGlj1aa ObDGgrpeeHryO7zzKilIU7bQ1OuJwFkekyS3OeRsgC+r14mHkxReMId/N76KDHbcTGo4 TtKApqax/5AfBZ/Sc1LSoLBSNkyPb3ZNKiMgJmgAHP8ueRE/8qoh5yjH84U5tvSIcv8L K+JPnOxAOq+TRdXFeKXtQfIuEFOy/i3iLGUP83rkX9Pdt+1IXgU8m4SIvkQtsON6ploB gJJD1HeT0S8lZ+uEqya5va66tJ+R3lAikARR9JHKOvMzPgyDVC/zCHNQrcrso6z/ovuN YEDg== X-Gm-Message-State: AOJu0Yy1NY9yVLuEBPCvSo4bdfFgF2Vxn3ceL2zWUqOwNig09q4bZTHx nd1BKgIp0wQgMPnWswhAx5s2aTGJFCyO//Fwl8TppOM4 X-Google-Smtp-Source: AGHT+IFeFtpVTnunbUuSCVxGoiucednKxXWC/xVr+hQbrg92qv/aQ72VhQ2MdM3DAIG/cpp4S2wBVFPtwErj191Fkuo= X-Received: by 2002:a2e:9d96:0:b0:2bc:ce85:2de2 with SMTP id c22-20020a2e9d96000000b002bcce852de2mr12240575ljj.37.1693140395922; Sun, 27 Aug 2023 05:46:35 -0700 (PDT) MIME-Version: 1.0 References: <20230826180748.15977-1-anton@khirnov.net> <20230826180748.15977-6-anton@khirnov.net> In-Reply-To: <20230826180748.15977-6-anton@khirnov.net> From: Stefano Sabatini Date: Sun, 27 Aug 2023 14:46:23 +0200 Message-ID: To: FFmpeg development discussions and patches X-Content-Filtered-By: Mailman/MimeDel 2.1.29 Subject: Re: [FFmpeg-devel] [PATCH 6/6] doc/developer: deduplicate commit message rules X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.29 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 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Archived-At: List-Archive: List-Post: Il sab 26 ago 2023, 20:08 Anton Khirnov ha scritto: > The patches/committing section currently contains several > partially-overlapping rules on commit messages. Merge and simplify them > into one item. > --- > doc/developer.texi | 41 ++++++++++++++++++----------------------- > 1 file changed, 18 insertions(+), 23 deletions(-) > > diff --git a/doc/developer.texi b/doc/developer.texi > index e4ba263581..fa417fc019 100644 > --- a/doc/developer.texi > +++ b/doc/developer.texi > @@ -340,13 +340,24 @@ missing samples or an implementation with a small > subset of features. > Always check the mailing list for any reviewers with issues and test > FATE before you push. > > -@subheading Keep the main commit message short with an extended > description below. > -The commit message should have a short first line in the form of > -a @samp{topic: short description} as a header, separated by a newline > -from the body consisting of an explanation of why the change is necessary. > -If the commit fixes a known bug on the bug tracker, the commit message > -should include its bug ID. Referring to the issue on the bug tracker does > -not exempt you from writing an excerpt of the bug in the commit message. > +@subheading Commit messages > +Commit messages are highly important tools for informing other developers > on > +what a given change does and why. Every commit must always have a properly > +filled out commit message with the following format: > +@example > +area changed: Short 1 line description Short => short given that we do not Capitalize + > +details describing what and why and giving references. > +@end example > + > +If the commit addresses a known bug on our bug tracker or other external > issue > +(e.g. CVE), the commit message should include the relevant bug ID(s) or > other > +external identifiers. Note that this should be done in addition to a > proper > +explanation and not instead of it. Comments such as "fixed!" or "Changed > it." > +are not acceptable. > + > +When applying patches that have been discussed at length on the mailing > list, > +reference the thread in the commit message. > > @subheading Testing must be adequate but not excessive. > If it works for you, others, and passes FATE then it should be OK to > commit > @@ -379,28 +390,12 @@ NOTE: If you had to put if()@{ .. @} over a large (> > 5 lines) chunk of code, > then either do NOT change the indentation of the inner part within (do not > move it to the right)! or do so in a separate commit > > -@subheading Commit messages should always be filled out properly. > -Always fill out the commit log message. Describe in a few lines what you > -changed and why. You can refer to mailing list postings if you fix a > -particular bug. Comments such as "fixed!" or "Changed it." are > unacceptable. > -Recommended format: > - > -@example > -area changed: Short 1 line description > - > -details describing what and why and giving references. > -@end example > - > @subheading Credit the author of the patch. > Make sure the author of the commit is set correctly. (see git commit > --author) > If you apply a patch, send an > answer to ffmpeg-devel (or wherever you got the patch from) saying that > you applied the patch. > > -@subheading Complex patches should refer to discussion surrounding them. > -When applying patches that have been discussed (at length) on the mailing > -list, reference the thread in the log message. > - > @subheading Always wait long enough before pushing changes > Do NOT commit to code actively maintained by others without permission. > Send a patch to ffmpeg-devel. If no one answers within a reasonable > Lgtm otherwise, thanks. > _______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".