From patchwork Thu Sep 28 20:28:22 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran O Leary X-Patchwork-Id: 5327 Delivered-To: ffmpegpatchwork@gmail.com Received: by 10.2.36.26 with SMTP id f26csp1230707jaa; Thu, 28 Sep 2017 13:28:31 -0700 (PDT) X-Received: by 10.28.232.138 with SMTP id f10mr1993907wmi.130.1506630510953; Thu, 28 Sep 2017 13:28:30 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1506630510; cv=none; d=google.com; s=arc-20160816; b=RfqF8jLe9Yf1VBeHnjV7mKHH49xNfcthUSONJ/VY13rxLqJo7keqSaGY0bYUc5SLm8 c1lQehksUmKT2WQPf/uFSZPnzjDSg/VmDXqV4GLlHiQ4vVqoRJgXNR61aH1XQ/wrO4uO ByjpUdfIX8/yyY136Wm4m0U61hpAgJzNK0SqLZmaZ6KGzYPmqc6HkNq4eBwBP1paFG99 jYMFSczcwL6SgEEilYhAA/rfDF+YndkoGAYfD5K4hekjZ4LH5uvkfq3HZQeX7jAYH6yF uP3H7bN2+wJe1OeOF8uSojkXMO2bdT7lVSw4U4NAvrJaKuiyUIi3mVhlx4eW/m0Aj6CK w//g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:reply-to:list-subscribe :list-help:list-post:list-archive:list-unsubscribe:list-id :precedence:subject:to:message-id:date:from:references:in-reply-to :mime-version:dkim-signature:delivered-to:arc-authentication-results; bh=SQJ3PdELgubEhBmUasLFWC8UAt+2bkI4LCR6zBMcaYc=; b=ZSqC8XdlQmSk3Si160inq9wL/202RY7PnZTKexBodMwDHhEGzQyU+Xb8xlSPtRPkF2 NFsVHTOlLOj29quRUk28FP8UUwUrj/jJVw43U6iSnLhdJG24j/SkrJpXW0YMofjA7Ssw 1kTfnxV+JcgCw9xm3PqcF6rDcpjWufOTT//NZ4o2I8K3MV/rVYr8/gLalt6lbEd23ykD e8GJ9Gn3OaQQu9Z7dGY2hXHyVxnfxb68hu4x/UjcItKa1KVlKMRI7LYo15rP+w0XgXM4 AIO3p54doxd+Rm7AxuM/ChuIFD2ChEyt1yGYCuvL4mb+GKXE8QzmXuL2GYzOqoGTfbI/ anQA== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20161025 header.b=mWUh1vVf; 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; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=gmail.com Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id 7si1393437wmx.90.2017.09.28.13.28.30; Thu, 28 Sep 2017 13:28:30 -0700 (PDT) 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=@gmail.com header.s=20161025 header.b=mWUh1vVf; 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; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=gmail.com Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 72FE6689230; Thu, 28 Sep 2017 23:28:16 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-wr0-f176.google.com (mail-wr0-f176.google.com [209.85.128.176]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 950EC688243 for ; Thu, 28 Sep 2017 23:28:10 +0300 (EEST) Received: by mail-wr0-f176.google.com with SMTP id 54so4779146wrz.10 for ; Thu, 28 Sep 2017 13:28:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:in-reply-to:references:from:date:message-id:subject:to; bh=P720kdiqsYzPiP+pLVMDcWXyjiz/j3pV5QUdyF+XO4I=; b=mWUh1vVfzbiKIhzalyW7ogr04fzuf9+8JxID2Lsqvlg84OtYmCSwKqbbEvc28FjyqP uy4KwOGQnhNx0uTYVmL1AX/fM7rXpHqCHQ6AMNQiP/4v/02wpX/kjQBvFyz6ITR7blMP 5fAG9HObgYs9I+owh0NBPHuhB9R19iZAxQwrfUMQnwW3pgqyWyYtQFhQYkQTS1O2l8Xl pVV1XKcyXripqbkfKAzHG9jCf/XKUmier/5zMi8W4DQxzCBKt3dXgAfnNGP5DBzk5Uos 9QGZWpFW0kGbvbNZ3W4124orr5ufuMnj0pWBtEdOhvyWhVVT/JZZszbWwo6h9GRK7gB+ eH2Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to; bh=P720kdiqsYzPiP+pLVMDcWXyjiz/j3pV5QUdyF+XO4I=; b=rbYvchFTJqIHNwOwhLbBJYvi54LZU/LLxjUSvUBlbMcnnrPlc9R5jVBpA1sGPFNU6b sbWy6GknuttfLnJPL9iuMSKEGg/o7QHGHKIDznvfhZZwjHrVG/T1Na21DPxVdi708v2U 87JnZdTwNrT9LeB66z1IBvxDpvAufjMnmuvMz5PahaHLkuJr840y3BhyeE/uPhCIQF4v cnKy7alFb8zyENMsOXpb+M1f7hfd2gkKKJioLgU8+HLWQkhYfxN85iYc9NXapmNJKMXq 3jz6mL9DgRIXS42agl3KH60nsK7CXo02bHTi3lKCo0+f3aEvT0g7DLfKSAmPZA5QRdXp vB9w== X-Gm-Message-State: AHPjjUgeQyinM7D3zfPt7vlciO1BhfjtFvfvdq8MOYwqCYqaKxLqRq2G Hd9cT/ZHKXIgfKTOgX2NUn4p54xKh9hOCc8+fP+an6U= X-Google-Smtp-Source: AOwi7QBy1mbKvqwrw7nHa4u6BkRHcH76SrTPEwxLv32wxh9oss+ETR4NIYk7mIWxO0SlDPLyLt6uayQTlDyTE/Iw9UI= X-Received: by 10.223.146.197 with SMTP id 63mr5173379wrn.180.1506630502783; Thu, 28 Sep 2017 13:28:22 -0700 (PDT) MIME-Version: 1.0 Received: by 10.28.6.2 with HTTP; Thu, 28 Sep 2017 13:28:22 -0700 (PDT) Received: by 10.28.6.2 with HTTP; Thu, 28 Sep 2017 13:28:22 -0700 (PDT) In-Reply-To: References: <20170927235955.23396-1-lou@lrcd.com> From: Kieran O Leary Date: Thu, 28 Sep 2017 21:28:22 +0100 Message-ID: To: FFmpeg development discussions and patches X-Content-Filtered-By: Mailman/MimeDel 2.1.20 Subject: Re: [FFmpeg-devel] [PATCH] doc: add mailing list faq 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 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Just one typo below, thanks for providing the html as well. On 28 Sep 2017 01:00, "Lou Logan" wrote: Signed-off-by: Lou Logan --- doc/Makefile | 1 + doc/mailing-list-faq.texi | 204 ++++++++++++++++++++++++++++++ ++++++++++++++++ 2 files changed, 205 insertions(+) create mode 100644 doc/mailing-list-faq.texi +@command{-hide_banner} options unless requested to do so. + +@item +If you attach files avoid compressing small files. Uncompressed is +preferred. +@end itemize + +@chapter Help + +@section Who do I contact if I have a problem with the mailing list? + +Send a message to @email{ffmpeg-user-owner@@ffmpeg.org}. + +@bye -- 2.14.1 diff --git a/doc/Makefile b/doc/Makefile index b670f0bd4c..9a4d225e65 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -24,6 +24,7 @@ HTMLPAGES = $(AVPROGS-yes:%=doc/%.html) $(AVPROGS-yes:%=doc/%-all.html) $(COMP doc/fate.html \ doc/general.html \ doc/git-howto.html \ + doc/mailing-list-faq.html \ doc/nut.html \ doc/platform.html \ diff --git a/doc/mailing-list-faq.texi b/doc/mailing-list-faq.texi new file mode 100644 index 0000000000..a047fdcd51 --- /dev/null +++ b/doc/mailing-list-faq.texi @@ -0,0 +1,204 @@ +\input texinfo @c -*- texinfo -*- +@documentencoding UTF-8 + +@settitle FFmpeg Mailing List FAQ +@titlepage +@center @titlefont{FFmpeg Mailing List FAQ} +@end titlepage + +@top + +@contents + +@chapter General Questions + +@section What is a mailing list? + +A mailing list is not much different than emailing someone, but the +main difference is that your message is received by everyone who +subscribes to the list. It is somewhat like a forum but in email form. + +See the @url{https://lists.ffmpeg.org/pipermail/ffmpeg-user/, ffmpeg-user archives} +for examples. + +@section What type of questions can I ask? + +@url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/, ffmpeg-user}: +For questions involving unscripted usage or compilation of the FFmpeg +command-line tools (@command{ffmpeg}, @command{ffprobe}, @command{ffplay}, +@command{ffserver}). + +@url{https://lists.ffmpeg.org/mailman/listinfo/libav-user/, libav-user}: +For questions involving the FFmpeg libav* libraries (libavcodec, +libavformat, libavfilter, etc). + +@url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel/, ffmpeg-devel}: +Only for discussions involving the development of FFmpeg and for +submitting patches. User questions should be asked at ffmpeg-user or +libav-user. + +To report a bug see @url{https://ffmpeg.org/bugreports.html}. + +We cannot provide help for scripts and/or third-party tools. + +@section How do I ask a question or send a message to the mailing list? + +E-mail @email{ffmpeg-user@@ffmpeg.org}. + +If you are not subscribed to the mailing list then your question must be +manually approved. Approval may take several days, but the wait is +usually less. If you want the message to be sent with no delay then you +must subscribe first. + +Please do not send a message, subscribe, and re-send the message: this +results in duplicates, causes more work for the admins, and may lower +your chance at getting an answer. However, you may do so if you first +@ref{How do I delete my message in the moderation queue, delete your original message from the moderation queue}. + +@chapter Subscribing / Unsubscribing + +@section Do I need to subscribe? + +No. + +However, you will not directly receive replies unless you ask to be CCd +in your message, but on occasion users will forget to CC you when +replying. Alternatively, you can view and reply to messages via the +@ref{Where are the archives, archives}. + +@section How do I subscribe? + +Email @email{ffmpeg-user-request@@ffmpeg.org} with the subject +@emph{subscribe}. + +Or visit the @url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/, ffmpeg-user mailing list info page} +and refer to the @emph{Subscribing to ffmpeg-user} section. + +The process is the same for the other mailing lists. + +@section How do I unsubscribe? + +Email @email{ffmpeg-user-request@@ffmpeg.org} with subject @emph{unsubscribe}. + +Or visit the @url{https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/, ffmpeg-user mailing list info page}, +scroll to bottom of page, enter your email address in the box, and click +the @emph{Unsubscribe or edit options} button. + +The process is the same for the other mailing lists. + +Please avoid asking a mail admin to unsubscribe you: there should be no +reason to do so. + +@anchor{How do I delete my message in the moderation queue} +@section How do I delete my message in the moderation queue? + +You should have received an email with the subject @emph{Your message to ffmpeg-user awaits moderator approval}. +A link is in the message that will allow you to delete your message +unless a mail admin already approved or rejected it. + +@chapter Archives + +@anchor{Where are the archives} +@section Where are the archives? + +See the @emph{Archives} section on the @url{https://ffmpeg.org/contact.html, FFmpeg Contact} +page for links to all FFmpeg mailing list archives. + +Note that the archives are split by month. Discussions that span +several months will be split into separate months. + +@section How do I reply to a message in the archives? + +Click the email link at the top of the message just under the subject +title. The link will provide the proper headers to keep the message +within the thread. + +@section Is there an alternative to the mailing list? + +You can ask for help in the official #ffmpeg IRC channel on Freenode. + +Some users prefer the third-party Nabble or Gmane interfaces which +present the mailing lists in a typical forum layout. + +@section How do I search the archives? + +Perform a site seach using your favorite search engine. Example: + site search +@t{site:lists.ffmpeg.org/pipermail/ffmpeg-user/ "search term"} + +@chapter Other + +@anchor{What is top-posting} +@section What is top-posting? + +See @url{https://en.wikipedia.org/wiki/Posting_style#Top-posting}. + +Instead, use trimmed interleaved/inline replies (@url{https://lists.ffmpeg. org/pipermail/ffmpeg-user/2017-April/035849.html, example}). + +@section What is the message size limit? + +The message size limit is 500k. Please provide links to larger files +instead of attaching them. Dropbox and Google Drive are acceptable +if you need a file host. + +@section What are the rules and the proper etiquette? + +There may seem to be many things to remember, but we want to help and +following these guidelines will allow you to get answers more quickly +and avoid getting ignored. + +@itemize +@item +Always show your actual, unscripted @command{ffmpeg} command and the +complete console output from your command. + +@item +Use the most simple and minimal command that still shows the issue you +are encountering. + +@item +Provide all necessary information so others can attempt to duplicate +your issue. This includes the actual command, complete console output, +and any inputs that are required to duplicate the issue. + +@item +Use the latest @command{ffmpeg} build you can get. See the @url{ https://ffmpeg.org/download.html, FFmpeg Download} +page for links to recent builds for Linux, macOS, and Windows. Or +compile from the current git master branch. + +@item +Avoid @url{https://en.wikipedia.org/wiki/Posting_style#Top-posting, top-posting}. +Also see @ref{What is top-posting, What is top-posting?} + +@item +Avoid hijacking threads. Thread hijacking is replying to a message and +changing the subject line to something unrelated to the original thread. +Most email clients will still show the renamed message under the +original thread. This can be confusing and these types of messages are +often ignored. + +@item +Do not send screenshots. Copy and paste console text instead of making +screenshots of the text. + +@item +Avoid sending email disclaimers and legalese if possible as this is a +public list. However, we are aware that many corporate users are unable +to avoid this. + +@item +Avoid using the @code{-loglevel debug}, @code{-loglevel quiet}, and