From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <ffmpeg-devel-bounces@ffmpeg.org>
Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100])
	by master.gitmailbox.com (Postfix) with ESMTPS id 7613D4CC75
	for <ffmpegdev@gitmailbox.com>; Tue, 13 May 2025 18:06:12 +0000 (UTC)
Received: from [127.0.1.1] (localhost [127.0.0.1])
	by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 99FCE68B404;
	Tue, 13 May 2025 21:05:32 +0300 (EEST)
Received: from mail-pl1-f170.google.com (mail-pl1-f170.google.com
 [209.85.214.170])
 by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 4EA2D68B2C3
 for <ffmpeg-devel@ffmpeg.org>; Tue, 13 May 2025 21:05:25 +0300 (EEST)
Received: by mail-pl1-f170.google.com with SMTP id
 d9443c01a7336-22fa414c565so45363775ad.2
 for <ffmpeg-devel@ffmpeg.org>; Tue, 13 May 2025 11:05:25 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=gmail.com; s=20230601; t=1747159523; x=1747764323; darn=ffmpeg.org;
 h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date
 :references:in-reply-to:message-id:from:from:to:cc:subject:date
 :message-id:reply-to;
 bh=bFbexVrIMncsZC8TIKV/HiETi1zVF3FALa2fmDZXjU8=;
 b=jk9FP4NsFN4sGg9RYZJCJah8rFoiIpcNvkX+6taUumbdydjBm2UOCywJU03Kv5EGa7
 1z+grC3raO94iVm4zMwYJnYYa5TBigyENYGw3V/mJmKUf4Zx2aBJSD7V3HtsE6/hUS5k
 Nk6Zcdakhljs9ASfytAN6qweWqIL/ypM98+JLUcRH3CmtoDry0a3SlKHY8KCyjWxc6YV
 WNV/b3xkRlM/wpexnb2AdfXf/yLLWWMhPsEoFjqkhBeALbJXzqvdqiZquGTKpCAebuOD
 +LwzBAf4vRcdTsvogq+WprGhy0JlGkyx1LKvQNufejc1Fg7Izt31YwxJE4NouT6VuFyl
 F6aA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1747159523; x=1747764323;
 h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date
 :references:in-reply-to:message-id:from:x-gm-message-state:from:to
 :cc:subject:date:message-id:reply-to;
 bh=bFbexVrIMncsZC8TIKV/HiETi1zVF3FALa2fmDZXjU8=;
 b=eMKjeyY5IiwUL6ac+lalK7aTW7s1fEuQMGI+Ud7J2jko0gPsqTAoCorBwR3hRj98kk
 ovDuaW4IBXwh/alk/lKuHcuKtjAW8Q6/WMT0/QQ/vsa7NjJ0qtWoGZxSaKJKSiIdhWHx
 IF5ZGQAIbB+/RkjDle+h35Qm7MggUbEs+k7y3jTrsmztkD6aF2PG4V5Lwb3K6StcuGX+
 wyBfHdC+6H2d9koVdhZjVp8sZfrpGxc0bBqItR1/ASh2cBcrfhht0VE/R+zh3UxsZijO
 2SSjHixBkIqBbkFXfK8MN1bbiwmmuPHnszfITaug/CP5/P9Z6GBVvBoUzhUw7AnEMhVp
 JTTA==
X-Gm-Message-State: AOJu0YyhRsq3Pd9ACNYUV1z+tdM1sVgdrOglxqBOY67U9+LMH3A0js/2
 K7IeaPBpEoIe0/LWTXCWcwgRaH8bHv0Z02y8rbWL9mJX8Bf6Mj6aYLGQHA==
X-Gm-Gg: ASbGncv5EGUrQKNOpnnTST+bpwYB3rrZR2pibMzF4I2SmlWs2yRybcbVRZSyo0oSKGD
 xP2Y+9siVTlJGd5ocY7C1/eu7gukj1xpawThPGTxPwH8MMhgBzS33AbhiRJy39e7/EHEG4Dsmb3
 Iaai1AORM5RMV+RPYSPSnH4RmpWzYxpWQKniPkyV4iwb33OWQRSqS32qgwGjCeQMTy+pifXdUGV
 qd4DTmeKnJEF5THvcLc6GFgTWXX14O4hYr+VtkbXWV4eZhxmML7i2uOunUTSwIo2ZS3oGEwwIfX
 NZJPjmzy6LU1Ck5ALLvCHCWvvWbLP3q7wLjln42yhJ82joi4cK3dAEi4tL9DoUJrhnCV7w==
X-Google-Smtp-Source: AGHT+IFM5ysOdrlyxgQ41imnqGUdeSq17FF1jsvAmWwNVZypo3+tMn4gJpXWeQX4Odh6K7aFFpWO+A==
X-Received: by 2002:a17:903:1aef:b0:21f:6a36:7bf3 with SMTP id
 d9443c01a7336-23198126227mr6547745ad.12.1747159522977; 
 Tue, 13 May 2025 11:05:22 -0700 (PDT)
Received: from [127.0.0.1] (master.gitmailbox.com. [34.83.118.50])
 by smtp.gmail.com with ESMTPSA id
 d9443c01a7336-22fc774134fsm84474155ad.56.2025.05.13.11.05.22
 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128);
 Tue, 13 May 2025 11:05:22 -0700 (PDT)
From: softworkz <ffmpegagent@gmail.com>
X-Google-Original-From: softworkz <softworkz@hotmail.com>
Message-Id: <79230103ee327ad5230b429d02a42492359f2b97.1747159511.git.ffmpegagent@gmail.com>
In-Reply-To: <pull.76.v2.ffstaging.FFmpeg.1747159511.ffmpegagent@gmail.com>
References: <pull.76.ffstaging.FFmpeg.1746699749.ffmpegagent@gmail.com>
 <pull.76.v2.ffstaging.FFmpeg.1747159511.ffmpegagent@gmail.com>
Date: Tue, 13 May 2025 18:05:08 +0000
Fcc: Sent
MIME-Version: 1.0
To: ffmpeg-devel@ffmpeg.org
Subject: [FFmpeg-devel] [PATCH v2 1/4] doc/developer: Move checklist into
 Submitting Patches chapter
X-BeenThere: ffmpeg-devel@ffmpeg.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: FFmpeg development discussions and patches <ffmpeg-devel.ffmpeg.org>
List-Unsubscribe: <https://ffmpeg.org/mailman/options/ffmpeg-devel>,
 <mailto:ffmpeg-devel-request@ffmpeg.org?subject=unsubscribe>
List-Archive: <https://ffmpeg.org/pipermail/ffmpeg-devel>
List-Post: <mailto:ffmpeg-devel@ffmpeg.org>
List-Help: <mailto:ffmpeg-devel-request@ffmpeg.org?subject=help>
List-Subscribe: <https://ffmpeg.org/mailman/listinfo/ffmpeg-devel>,
 <mailto:ffmpeg-devel-request@ffmpeg.org?subject=subscribe>
Reply-To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Cc: softworkz <softworkz@hotmail.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: ffmpeg-devel-bounces@ffmpeg.org
Sender: "ffmpeg-devel" <ffmpeg-devel-bounces@ffmpeg.org>
Archived-At: <https://master.gitmailbox.com/ffmpegdev/79230103ee327ad5230b429d02a42492359f2b97.1747159511.git.ffmpegagent@gmail.com/>
List-Archive: <https://master.gitmailbox.com/ffmpegdev/>
List-Post: <mailto:ffmpegdev@gitmailbox.com>

From: softworkz <softworkz@hotmail.com>

Signed-off-by: softworkz <softworkz@hotmail.com>
---
 doc/developer.texi | 192 +++++++++++++++++++++++----------------------
 1 file changed, 98 insertions(+), 94 deletions(-)

diff --git a/doc/developer.texi b/doc/developer.texi
index 108558b9e0..42e42350a5 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -722,101 +722,8 @@ and has no lrint()')
 Also please if you send several patches, send each patch as a separate mail,
 do not attach several unrelated patches to the same mail.
 
-Patches should be posted to the
-@uref{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel, ffmpeg-devel}
-mailing list. Use @code{git send-email} when possible since it will properly
-send patches without requiring extra care. If you cannot, then send patches
-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.
-
-@subheading How to setup git send-email?
-
-Please see @url{https://git-send-email.io/}.
-For gmail additionally see @url{https://shallowsky.com/blog/tech/email/gmail-app-passwds.html}.
-
-@subheading Sending patches from email clients
-Using @code{git send-email} might not be desirable for everyone. The
-following trick allows to send patches via email clients in a safe
-way. It has been tested with Outlook and Thunderbird (with X-Unsent
-extension) and might work with other applications.
-
-Create your patch like this:
-
-@verbatim
-git format-patch -s -o "outputfolder" --add-header "X-Unsent: 1" --suffix .eml --to ffmpeg-devel@ffmpeg.org -1 1a2b3c4d
-@end verbatim
-
-Now you'll just need to open the eml file with the email application
-and execute 'Send'.
-
-@subheading Reviews
-Your patch will be reviewed on the mailing list. 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.
-
 
-@chapter 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{codec_id.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_contents.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 submission checklist
+@section Patch submission checklist
 
 @enumerate
 @item
@@ -927,6 +834,103 @@ Test your code with valgrind and or Address Sanitizer to ensure it's free
 of leaks, out of array accesses, etc.
 @end enumerate
 
+
+@section Submission procedures
+
+Patches should be posted to the
+@uref{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel, ffmpeg-devel}
+mailing list. Use @code{git send-email} when possible since it will properly
+send patches without requiring extra care. If you cannot, then send patches
+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.
+
+@subheading How to setup git send-email?
+
+Please see @url{https://git-send-email.io/}.
+For gmail additionally see @url{https://shallowsky.com/blog/tech/email/gmail-app-passwds.html}.
+
+@subheading Sending patches from email clients
+Using @code{git send-email} might not be desirable for everyone. The
+following trick allows to send patches via email clients in a safe
+way. It has been tested with Outlook and Thunderbird (with X-Unsent
+extension) and might work with other applications.
+
+Create your patch like this:
+
+@verbatim
+git format-patch -s -o "outputfolder" --add-header "X-Unsent: 1" --suffix .eml --to ffmpeg-devel@ffmpeg.org -1 1a2b3c4d
+@end verbatim
+
+Now you'll just need to open the eml file with the email application
+and execute 'Send'.
+
+@subheading Reviews
+Your patch will be reviewed on the mailing list. 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.
+
+
+@chapter 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{codec_id.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_contents.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
-- 
ffmpeg-codebot

_______________________________________________
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".