From: softworkz <ffmpegagent@gmail.com> To: ffmpeg-devel@ffmpeg.org Cc: softworkz <softworkz@hotmail.com> Subject: [FFmpeg-devel] [PATCH 3/5] doc/developer: Reorder Submission procedures content Date: Thu, 08 May 2025 10:22:27 +0000 Message-ID: <866fd3aa3bde0d6e6bbdf1bee98b52ac6aef7f35.1746699749.git.ffmpegagent@gmail.com> (raw) In-Reply-To: <pull.76.ffstaging.FFmpeg.1746699749.ffmpegagent@gmail.com> From: softworkz <softworkz@hotmail.com> Signed-off-by: softworkz <softworkz@hotmail.com> --- doc/developer.texi | 48 ++++++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 23 deletions(-) diff --git a/doc/developer.texi b/doc/developer.texi index a723d41f39..5a026fff0e 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -752,10 +752,7 @@ We think our rules are not too hard. If you have comments, contact us. First, 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 :-). - -Also please do not submit a patch which contains several unrelated changes. +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 @@ -768,13 +765,6 @@ The tool is located in the tools directory. Run the @ref{Regression tests} before submitting a patch in order to verify it does not cause unexpected problems. -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()') - -Also please if you send several patches, send each patch as a separate mail, -do not attach several unrelated patches to the same mail. - @section Patch submission checklist @@ -892,23 +882,35 @@ of leaks, out of array accesses, etc. 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. +mailing list. + +There are several ways how this can be accomplished: -@subheading How to setup git send-email? +@subsection Using @code{git send-email}: Git sends e-mail directly via SMTP + +@code{git send-email} will properly format and send +send patches without requiring extra care if the required setup is feasible. 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 + +@subsection With @code{git format-patch}: Sending patches from email clients + +You can create patch files via @code{git format-patch} and send them as inline +text or 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). + +If you send several patches, send each patch as a separate mail, +do not attach several unrelated patches to the same mail. + +You can check @url{https://patchwork.ffmpeg.org}, if your patch does not show up, its mime type +likely was wrong. + + +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. -- 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".
next prev parent reply other threads:[~2025-05-08 10:23 UTC|newest] Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top 2025-05-08 10:22 [FFmpeg-devel] [PATCH 0/5] doc/developer: Add subsection about patch submission via FFstaging ffmpegagent 2025-05-08 10:22 ` [FFmpeg-devel] [PATCH 1/5] doc/developer: Move checklist into Submitting Patches chapter softworkz 2025-05-08 10:22 ` [FFmpeg-devel] [PATCH 2/5] doc/developer: Move codecs/formats checklist into Development Policy chapter softworkz 2025-05-08 10:22 ` softworkz [this message] 2025-05-08 10:22 ` [FFmpeg-devel] [PATCH 4/5] doc/developer: Merge Review paragraphs and deduplicate softworkz 2025-05-08 10:22 ` [FFmpeg-devel] [PATCH 5/5] doc/developer: Add subsection about patch submission via FFstaging softworkz 2025-05-08 12:40 ` James Almer 2025-05-08 12:55 ` softworkz . 2025-05-08 11:13 ` [FFmpeg-devel] [PATCH 0/5] " softworkz . 2025-05-08 11:20 ` Lynne 2025-05-08 11:33 ` softworkz . 2025-05-08 11:59 ` Lynne 2025-05-08 12:26 ` softworkz . 2025-05-08 12:36 ` Lynne 2025-05-08 12:47 ` Nicolas George 2025-05-08 13:12 ` softworkz . 2025-05-09 10:17 ` softworkz . 2025-05-13 18:05 ` [FFmpeg-devel] [PATCH v2 0/4] doc/developer: Restructure docs about patch submission ffmpegagent 2025-05-13 18:05 ` [FFmpeg-devel] [PATCH v2 1/4] doc/developer: Move checklist into Submitting Patches chapter softworkz 2025-05-13 18:05 ` [FFmpeg-devel] [PATCH v2 2/4] doc/developer: Move codecs/formats checklist into Development Policy chapter softworkz 2025-05-13 18:05 ` [FFmpeg-devel] [PATCH v2 3/4] doc/developer: Reorder Submission procedures content softworkz 2025-05-13 18:05 ` [FFmpeg-devel] [PATCH v2 4/4] doc/developer: Merge Review paragraphs and deduplicate softworkz
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=866fd3aa3bde0d6e6bbdf1bee98b52ac6aef7f35.1746699749.git.ffmpegagent@gmail.com \ --to=ffmpegagent@gmail.com \ --cc=ffmpeg-devel@ffmpeg.org \ --cc=softworkz@hotmail.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel This inbox may be cloned and mirrored by anyone: git clone --mirror https://master.gitmailbox.com/ffmpegdev/0 ffmpegdev/git/0.git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V2 ffmpegdev ffmpegdev/ https://master.gitmailbox.com/ffmpegdev \ ffmpegdev@gitmailbox.com public-inbox-index ffmpegdev Example config snippet for mirrors. AGPL code for this site: git clone https://public-inbox.org/public-inbox.git