From patchwork Mon Dec 4 07:09:02 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jim DeLaHunt X-Patchwork-Id: 6538 Delivered-To: ffmpegpatchwork@gmail.com Received: by 10.2.161.94 with SMTP id m30csp4060740jah; Sun, 3 Dec 2017 23:09:31 -0800 (PST) X-Google-Smtp-Source: AGs4zMZS0wFbabTBhGaZiEAyqu70bQY2+vMTY2gKknXrztpUKbhHZ+mo3JSlypwAa6oqqVqIOkbx X-Received: by 10.28.64.68 with SMTP id n65mr2518536wma.0.1512371371452; Sun, 03 Dec 2017 23:09:31 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1512371371; cv=none; d=google.com; s=arc-20160816; b=FpE3oYKGgAJooZUTDTUYkuSOv32P5w+qngW1i5DQ3uADhba/7D3RqVOzeUz+lnSByI i5kZN2kgWE+BoU9DNzD8AdBsCFLaDd7RX54ww5BOZKWXYAncnoM37XeYWf2BDWSgfv8u AnUpKx6lw9sWxKeJ+MqpSrixr+1VOvN86LQmwB5zFDxOrO75OB1rsjN8cmu7kPSf2ikn kbbhVQF0anWyWSyNIXoxH1riRzL+6TQCqQ/6hFcpY8G5aLLUsUz2/9ntxV05Uo6jqbqr o4U5FFI71QkYIp0OycocibcfWGGEcUejK/Nitfk3NOvWfOTCA1xkEQAF19SenZp7d85N y4WA== 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:references:in-reply-to:message-id:date :to:from:dkim-signature:delivered-to:arc-authentication-results; bh=ymzT1XFS4RaY9cVqy2QSgxd23zj8furXR4ma4Zvs1v4=; b=EMfP98310c+BUAostGH2i7ZU2+SnSjiLTDgVvec5AGCehLoE3yrgYadSOtaF7G5RXl UkkYDA1We2NTJR2wz9vp6UZmxL76v4O4D+IkxIzTEgighserJTikX9W/b6CImCPf4D+4 0FwiqiP6VY7/einnRKcfh0vW7USEQf+6dhCNI1mW22yRt5NlIn1eU5Tbi09yZzKuJ7d8 ElzbCZ5YFFm8Q99mizSwONbbf/dMpBaLj3wzMTFjtlkgOHcZQSNN4SF4vwb/SinJU4Ha G/DUtF6TCsRh6yBjsIxXmsVV0y6ybiw6ozQYD1MMmaCRGQMIKccaKV4kZxUM59fzfmz4 W+Ag== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@jdlh.com header.s=jdlh.com header.b=mbQmNpyU; 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 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id v13si4479404wmc.146.2017.12.03.23.09.30; Sun, 03 Dec 2017 23:09:31 -0800 (PST) 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=@jdlh.com header.s=jdlh.com header.b=mbQmNpyU; 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 Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id EFB2368A2D0; Mon, 4 Dec 2017 09:09:24 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from homiemail-a23.g.dreamhost.com (sub3.mail.dreamhost.com [69.163.253.7]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 8895E68A298 for ; Mon, 4 Dec 2017 09:09:18 +0200 (EET) Received: from homiemail-a23.g.dreamhost.com (localhost [127.0.0.1]) by homiemail-a23.g.dreamhost.com (Postfix) with ESMTP id 4346D4B007C; Sun, 3 Dec 2017 23:09:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=jdlh.com; h=from:to:cc :subject:date:message-id:in-reply-to:references; s=jdlh.com; bh= GkcfEChr8vb1xgbu6d/wzIs/5RA=; b=mbQmNpyU9rkUl5Nmb18BoSM5c18D2ZfT 9h4La5AZVp9zkHvEDwjYRm+RHrDY+pRyOByX4Zlx6kS2jXv8yJRtFuPlnjY+lvd2 p5Sl89mV6AKt4PWLhziSsTgGnYTv/MtQqzjyL6+jLeHFLzb7F/cT5mGDQvH02egg mHYERSdPNdQ= Received: from localhost.localdomain (216-19-185-177.dyn.novuscom.net [216.19.185.177]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) (Authenticated sender: jdlh@jdlh.com) by homiemail-a23.g.dreamhost.com (Postfix) with ESMTPSA id 174704B006F; Sun, 3 Dec 2017 23:09:21 -0800 (PST) From: Jim DeLaHunt To: ffmpeg-devel@ffmpeg.org Date: Sun, 3 Dec 2017 23:09:02 -0800 Message-Id: <20171204070902.54949-1-from.ffmpeg-dev@jdlh.com> X-Mailer: git-send-email 2.12.2 In-Reply-To: References: Subject: [FFmpeg-devel] [PATCH] Add doc on ffmpeg-devel, update on -cvslog list (v3) 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: Jim DeLaHunt MIME-Version: 1.0 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" The Developer Documentation had instructions to subscribe to the ffmpeg-cvslog email list. But that is no longer accurate. For the purposes in this section -- review of patches, discussion of development issues -- ffmpeg_devel is the appropriate email list. Some developers may want to monitor ffmpeg-cvslog, but it is not mandatory. This is v3 of this doc, based on discussion in thread and in response to docs Maintainer comments in . 1. In doc/developer.texi, add a new section about ffmpeg-devel, based on existing text from ffmpeg-cvslog section regarding discussion of patches and of development issues. Reflect wording from discussion at but with copy-editing to make wording more concise. 2. In doc/developer.texi, rewrite the ffmpeg-cvslog section to match the current usage of ffmpeg-cvslog. Some developers choose to follow this list, but it is not mandatory. There are a lot of improvements possible to the Developer Documentation page, beyond this refactoring. However, making those improvements is a much bigger and more difficult task. This change is "low hanging fruit". Signed-off-by: Jim DeLaHunt --- doc/developer.texi | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/doc/developer.texi b/doc/developer.texi index 89124a295c..65f2630e69 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -380,12 +380,30 @@ always check values read from some untrusted source before using them as array index or other risky things. @section Documentation/Other +@subheading Subscribe to the ffmpeg-devel mailing list. +It is important to be subscribed to the +@uref{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel, ffmpeg-devel} +mailing list. Almost any non-trivial patch is to be sent there +for review. Other developers may have comments about your contribution. +We expect you see those comments, and to improve it if requested. +(N.B. Experienced committers have other channels, +and may sometimes skip review for trivial fixes.) +Also, discussion here about bug fixes and ffmpeg improvements by +other developers may be helpful information for you. +Finally, by being a list subscriber, your contribution will be posted +immediately to the list, without the moderation hold +which messages from non-subscribers experience. + +However, it is more important to the project that we receive your +patch than that you be subscribed to the ffmpeg-devel list. If you +have a patch, and don't want to subscribe and discuss the patch, +then please do send it to the list. @subheading Subscribe to the ffmpeg-cvslog mailing list. -It is important to do this as the diffs of all commits are sent there and -reviewed by all the other developers. Bugs and possible improvements or -general questions regarding commits are discussed there. We expect you to -react if problems with your code are uncovered. +Diffs of all commits are sent to the +@uref{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-cvslog, ffmpeg-cvslog} +mailing list. Some developers read this list to review all code base changes +from all sources. Subscribing to this list is not mandatory. @subheading Keep the documentation up to date. Update the documentation if you change behavior or add features. If you are