From patchwork Sat Aug 5 09:42:06 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nicolas George X-Patchwork-Id: 4629 Delivered-To: ffmpegpatchwork@gmail.com Received: by 10.103.46.211 with SMTP id u202csp478207vsu; Sat, 5 Aug 2017 02:42:23 -0700 (PDT) X-Received: by 10.28.18.66 with SMTP id 63mr3304098wms.20.1501926143565; Sat, 05 Aug 2017 02:42:23 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1501926143; cv=none; d=google.com; s=arc-20160816; b=UobDfzGiZuQsUqtBKsBVs7baStAx2PybmlaXoZLUqzXkowtTuOtA25kCNLzH2ikGVs 3fTwe13cikbpNMSLSAfIalI2USu+TRfJ0JPp19gu9gAKKN69WldYTKVss0pgiDCYjLmc vRCBlxs1b07HnAJcEKIRlnoZyHS4kAUoOTqe8yHazBulT0z8AmNfIGQUEcyjHXuw49Io 8hguBscQOUGFe3si1/7Gzcpj5G9BnvFczGSgX+hfXabW7V0AJvK8kIIzvT+KW53vgo0c AjjUpaMPswJ7FDHkRLEXXbQFOGiwP+UXJkN7YIERNEJuQODx5fuSClqfpd0mdstm/VoF VBsw== 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:delivered-to :arc-authentication-results; bh=bq4AglbCrbRpTTm/qzMhS5UyrNNx1JS29ceF9wU42mw=; b=ZjTs8ktyZWhJZFY8tGfp1hj1Zys5ENTphW0/FjKqV3OcAfETlGA+Deac2W5RujGiGR iX7XD1VN60lNPsQHXZx3JpA8VLrHCDUKc7dXNp621vE6o4KbE3PooKPxOL2rI8KE2zCw U1i9RImF8ZMYhLuKahppntwlBlLLSbMuhyPMsAFK0RTKheRUgnnGkTA0P8eNf0HFXzn/ DyOYv7s54z8GKOSEzYyLpJo4A1qH7m23kyOj2UbOJx7C4I1YTxPpB3SMqkR0pPKSNIcL R2GJZmt+hwpJm9h9IqVq89muj56fdYYqBz5e8Nkb9oKgphRwCdNOapejorS1eqRUzlt/ J7UA== ARC-Authentication-Results: i=1; mx.google.com; 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 q14si4972339wrd.263.2017.08.05.02.42.23; Sat, 05 Aug 2017 02:42:23 -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; 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 D2BA7680474; Sat, 5 Aug 2017 12:42:19 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from nef2.ens.fr (nef2.ens.fr [129.199.96.40]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 89F2F68021A for ; Sat, 5 Aug 2017 12:42:13 +0300 (EEST) Received: from phare.normalesup.org (phare.normalesup.org [129.199.129.80]) by nef2.ens.fr (8.13.6/1.01.28121999) with ESMTP id v759gDp3010007 for ; Sat, 5 Aug 2017 11:42:13 +0200 (CEST) Received: by phare.normalesup.org (Postfix, from userid 1001) id 7EBF7E3ED1; Sat, 5 Aug 2017 11:42:13 +0200 (CEST) From: Nicolas George To: ffmpeg-devel@ffmpeg.org Date: Sat, 5 Aug 2017 11:42:06 +0200 Message-Id: <20170805094206.21791-1-george@nsup.org> X-Mailer: git-send-email 2.13.2 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3 (nef2.ens.fr [129.199.96.32]); Sat, 05 Aug 2017 11:42:13 +0200 (CEST) Subject: [FFmpeg-devel] [PATCH] doc/filters: document the unstability of the shorthand options notation. 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: Nicolas George --- doc/filters.texi | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/filters.texi b/doc/filters.texi index 7e5a9a625a..886cd5a7e8 100644 --- a/doc/filters.texi +++ b/doc/filters.texi @@ -161,6 +161,11 @@ follow the same constraints order of the previous point. The following @end itemize +Future evolutions of filters may require inserting new options or changing +their order, especially for the non-essential options, and that would break +options given without their name. For that reason, uses that require +stability should favor the @var{key=value} notation. + If the option value itself is a list of items (e.g. the @code{format} filter takes a list of pixel formats), the items in the list are usually separated by @samp{|}.