[FFmpeg-devel] [PATCH v2 0/4] doc/developer: Restructure docs about patch submission
ffmpegagent
ffmpegagent at gmail.com
Tue May 13 21:05:07 EEST 2025
The https://ffmpeg.org/developer.html (doc/developer.texi) page contains a
lot of good information but there's some structural and contentual
duplication that is begging for cleanup:
3 Development Policy
[https://ffmpeg.org/developer.html#Development-Policy-1] 4 Submitting
patches [https://ffmpeg.org/developer.html#Submitting-patches-1] 5 New
codecs or formats checklist
[https://ffmpeg.org/developer.html#New-codecs-or-formats-checklist] 6 Patch
submission checklist
[https://ffmpeg.org/developer.html#Patch-submission-checklist] 7 Patch
review process [https://ffmpeg.org/developer.html#Patch-review-process]
* a Patch submission checklist clearly belongs to the context of
"Submitting Patches"
* a checklist about the requirements for adding new codecs/formats is
mostly a matter of policies
* after moving 5 into 3 and 6 into 4, another duplication can be resolved
elegantly as 4 ends with a section about patch reviews which is then
adjacent to the current 7 (patch review process)
* inside 4:
* some duplication between 4's intro and the checklist can be removed
* the second part becomes "Submission procedures" with two subsections
(send-email and format-patch) and the content separated in a more
logical way
Versions
========
V2
==
* Removed the 5th commit due to controversial reception
The other changes are still worthwhile for review
.
softworkz (4):
doc/developer: Move checklist into Submitting Patches chapter
doc/developer: Move codecs/formats checklist into Development Policy
chapter
doc/developer: Reorder Submission procedures content
doc/developer: Merge Review paragraphs and deduplicate
doc/developer.texi | 218 +++++++++++++++++++++++----------------------
1 file changed, 111 insertions(+), 107 deletions(-)
base-commit: 1b643e3f65d75a4e6a25986466254bdd4fc1a01a
Published-As: https://github.com/ffstaging/FFmpeg/releases/tag/pr-ffstaging-76%2Fsoftworkz%2Fsubmit_website_update-v2
Fetch-It-Via: git fetch https://github.com/ffstaging/FFmpeg pr-ffstaging-76/softworkz/submit_website_update-v2
Pull-Request: https://github.com/ffstaging/FFmpeg/pull/76
Range-diff vs v1:
1: 79230103ee = 1: 79230103ee doc/developer: Move checklist into Submitting Patches chapter
2: ae47e8bda0 = 2: ae47e8bda0 doc/developer: Move codecs/formats checklist into Development Policy chapter
3: 866fd3aa3b = 3: 866fd3aa3b doc/developer: Reorder Submission procedures content
4: 2e4a47f000 = 4: 2e4a47f000 doc/developer: Merge Review paragraphs and deduplicate
5: c8dba13b92 < -: ---------- doc/developer: Add subsection about patch submission via FFstaging
--
ffmpeg-codebot
More information about the ffmpeg-devel
mailing list