From patchwork Wed Sep 27 23:59:55 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lou Logan X-Patchwork-Id: 5320 Delivered-To: ffmpegpatchwork@gmail.com Received: by 10.2.36.26 with SMTP id f26csp140844jaa; Wed, 27 Sep 2017 17:00:06 -0700 (PDT) X-Google-Smtp-Source: AOwi7QAdbqogkWwgYy9CGZisT4mYvetxE/t87Lql2I+eun2Q8Zy4/ZAwJkcRAzb9ksXeM94FWGGD X-Received: by 10.28.19.11 with SMTP id 11mr1773274wmt.122.1506556806400; Wed, 27 Sep 2017 17:00:06 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1506556806; cv=none; d=google.com; s=arc-20160816; b=l2nEIPPx35f1KN05ib8DVLxdLFJv6g42+A6KmbxCgS0ABQwymh4T0Ur5yFBDex9+pu yEGa283srBGfcWvoLxDBhtYjeYtc2iLIlKYytXjXYq9NHpPWqLMIqJl2+wNm7KkNDue3 DMXoTV48Ds1ad/Cu+m8+GskIAYL1KMJQ5hSFHA7rDwY7cR32JUyvuwlq32qhBdxzm9uC Ml6VjcOXq9+EvMnSzyKixlUHUytxiRsW/+pKGcWDnaf03xul/pPvXm+xVXu41DkC0nPf nmZvIGgzenUaluacUmmYa4NwqhGh3mlSgAF17Tp3G4q6FGGcgOHb1MCp+UsQC3Hg+wKP BEVA== 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:reply-to :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:message-id:date:to:from:dkim-signature :dkim-signature:delivered-to:arc-authentication-results; bh=wRLEDNiUSD0AIG/Atq3NhBlbqg585/rx1mkGk1KkP+c=; b=x+qBjFKTEN1ZAtdTZx/m5Z8lpJL4ZNS5ttziofPdRp7GepiKEcAoNnOHSAX62LU8FO q7qMn+1xB1tbJiI+Qn1ZeOEBGxjvUiZXFT3b/sZAeNduIEB2OV+xbcWaON4ha2ccR0/y u52pzFBFJNiFPxdWc6G5CT7qOeG4iY3agGUuQknJ3FRIromf+wCiMIbkFGuTNYI6ceLp 9l9faFAWWazS/qh7X/w+W1qjQmufuaYu+DS6clXa+cRvgnWi3LgalM0JHFbJZvrCT/6R DLZzDv5zNcNjWkRiGRcTajDQWOR8aKMeEfETHVXbsVZ2GgYeYQlj/26trw66sC4vlBUo 12fQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@lrcd.com header.s=fm1 header.b=flfcUtN+; dkim=neutral (body hash did not verify) header.i=@messagingengine.com header.s=fm1 header.b=ZeuN8zmg; 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 d18si148350wrg.258.2017.09.27.17.00.05; Wed, 27 Sep 2017 17:00:06 -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=@lrcd.com header.s=fm1 header.b=flfcUtN+; dkim=neutral (body hash did not verify) header.i=@messagingengine.com header.s=fm1 header.b=ZeuN8zmg; 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 09382689AC6; Thu, 28 Sep 2017 02:59:52 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 67AC3689A4A for ; Thu, 28 Sep 2017 02:59:45 +0300 (EEST) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id 1F1C120D7C; Wed, 27 Sep 2017 19:59:57 -0400 (EDT) Received: from frontend1 ([10.202.2.160]) by compute2.internal (MEProxy); Wed, 27 Sep 2017 19:59:57 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lrcd.com; h=date :from:message-id:subject:to:x-me-sender:x-me-sender:x-sasl-enc :x-sasl-enc; s=fm1; bh=QyID2LolmsnaAsV7ApJmWmxo7uYoQGTzY3k8OwWX/ 40=; b=flfcUtN+VhUO4SL+USKFIVVNFZL7wF+0Bbg5pU72gpE4d5d4suD1jxhJ4 7v1p68th4cNiWE5IzL6f8tFvfYY0dnzd8cRsLLSWtjnGKBPIfrcxWqnW2MXFjxfd 2FOTXInLECmSRzZPTRp85zBo3l+VVJbG5KWKtQbuUphDmxbvUaUSwEgox/MSVPUg Nfxthvd1vG6wcjrpyXRMLVvRyOAzo9UePlnGNo6e+acOAJom81gNSVCKcPb48VEi A2230/PQpuGE0PANJuYo9XeCj2PiHCUIXHm2p/ELL57fPnU5+Q60OkCCtOXmzf3X z2aYsNyuEUXm/T2aPvPp3EY2JDfFQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=date:from:message-id:subject:to :x-me-sender:x-me-sender:x-sasl-enc:x-sasl-enc; s=fm1; bh=QyID2L olmsnaAsV7ApJmWmxo7uYoQGTzY3k8OwWX/40=; b=ZeuN8zmgp9bml1brTs4vSZ fPX1b3rR0N5f1c22hRJMAhEiOCZMRYtPciAi85Q4SdrEYl7fX872OkrZbN3kY03E kC5bUYchzrO98e0KHkp6UBhFPEIH1HITM7DXAbckoIoHMtRHmlVwcEHgkxp+zkWv 1vEsRYM3B25U+uvyeFnWF6GlUazbUOYBiNAP7UP250AjJxRdWPBnw84rieN8BvJd UneXaMzUiRZHUcCMYHghK/3g4BLGNSOkTwWIXQ9d2Y66n3+JMuYDe5jtg0XjylnO XCAfKdex9uwLQZyaL2VOC5fHdOeleoj99Xo0JQRs8SefmdTqkuON7vOSH+C2g7lQ == X-ME-Sender: X-Sasl-enc: 8J/4B1YpAahpQMtDgobMAYSMuY4Y4NGPMLIY07KLaW62 1506556796 Received: from localhost (21-29-237-24.gci.net [24.237.29.21]) by mail.messagingengine.com (Postfix) with ESMTPA id ABCEC7FAAE for ; Wed, 27 Sep 2017 19:59:56 -0400 (EDT) From: Lou Logan To: ffmpeg-devel@ffmpeg.org Date: Wed, 27 Sep 2017 15:59:55 -0800 Message-Id: <20170927235955.23396-1-lou@lrcd.com> X-Mailer: git-send-email 2.14.1 Subject: [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 MIME-Version: 1.0 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" 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 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: + +@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 +@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