From patchwork Mon Nov 14 09:13:06 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anton Khirnov X-Patchwork-Id: 39267 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a21:999a:b0:a4:2148:650a with SMTP id ve26csp2304905pzb; Mon, 14 Nov 2022 01:13:43 -0800 (PST) X-Google-Smtp-Source: AA0mqf50qR5p5+2xa6Wpg2nTJrnefc/DpwRfgHs6NZAkgrISZLd2LmhFzv3BJnR1BQR5ygrcKVOX X-Received: by 2002:a17:906:d1d0:b0:7ad:88f8:6a53 with SMTP id bs16-20020a170906d1d000b007ad88f86a53mr9876117ejb.61.1668417223364; Mon, 14 Nov 2022 01:13:43 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1668417223; cv=none; d=google.com; s=arc-20160816; b=RocbrdV9GKixNMRVVujkHA69r2JtXQdQsZTcrZ7ifuy6iVxFi1r33HO7hl8qvoR1A1 YNat5tFa3ky3RNpdHXrCW1+ireeGCeGpqr2hOdzefhinpC+3fXbg4jeeRl2G/1qnA0EH 4EgeV7E5ZfB3LjYcmSGCtgECUWT1wpXCMYxE589u5qCJaLvE8Y90pHqciFt2EXD4bPnc Nsw8Z1AaETILU6YcGdMf5PoNd5a1OCGcSO/mI+VVRkTH/AvDcgd2lpxBtmdjO+T5OBpv 1gs+m3lVVGfSnzzAo26oeSI6v+gBQCtpwYotyYrPR5K5YyiM5uGDZoEHFOLutZzAVU7b lCFg== 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:mime-version:message-id:date:to:from :delivered-to; bh=9DAULucUHC79stuPHC4vyQcCyTBXXxmEPOmKqKqVSPA=; b=BIU7M2QYz+ax2yxIIWh1lNM6SC1vDjKzL09rvWB97JJKdkDmh4WuvTD9f6E0EeiHgz GbBWCJUpGipJHrd9JbJbPKRHdsdw1sARG8KgyipJ8fJgKvgrDAdWrlT+zoLVq5akm78c 2mthyljvtltvKVot8cGLsxgUTqpz3G6n+XDiT3quuhFOa75ulWQrO3N3YKg388zPVehL 2KQ11JwYbE3Vj1js6EEOHs4VkMQlSxT2rBzCJFPtQe8p2Cu0Bu1ubCGkMTOxfxRKR2+I t3nla5278mAZjN8xD76LFiqruuPz3oxKAe74OppuKtuyJeXqCIFmjw19JydAz1ys54D/ JOCg== 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 e7-20020a50fb87000000b0046272b487cesi7525228edq.331.2022.11.14.01.13.36; Mon, 14 Nov 2022 01:13:43 -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; 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 0E3C068BD5A; Mon, 14 Nov 2022 11:13:33 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail0.khirnov.net (red.khirnov.net [176.97.15.12]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 38258689993 for ; Mon, 14 Nov 2022 11:13:26 +0200 (EET) Received: from localhost (localhost [IPv6:::1]) by mail0.khirnov.net (Postfix) with ESMTP id A641C240591 for ; Mon, 14 Nov 2022 10:13:25 +0100 (CET) Received: from mail0.khirnov.net ([IPv6:::1]) by localhost (mail0.khirnov.net [IPv6:::1]) (amavisd-new, port 10024) with ESMTP id lKs59ZOeofYl for ; Mon, 14 Nov 2022 10:13:25 +0100 (CET) Received: from libav.khirnov.net (libav.khirnov.net [IPv6:2a00:c500:561:201::7]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "libav.khirnov.net", Issuer "smtp.khirnov.net SMTP CA" (verified OK)) by mail0.khirnov.net (Postfix) with ESMTPS id 124452400F5 for ; Mon, 14 Nov 2022 10:13:25 +0100 (CET) Received: from libav.khirnov.net (libav.khirnov.net [IPv6:::1]) by libav.khirnov.net (Postfix) with ESMTP id 5C8CA3A0212 for ; Mon, 14 Nov 2022 10:13:17 +0100 (CET) From: Anton Khirnov To: ffmpeg-devel@ffmpeg.org Date: Mon, 14 Nov 2022 10:13:06 +0100 Message-Id: <20221114091309.15755-1-anton@khirnov.net> X-Mailer: git-send-email 2.35.1 MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH 1/4] doc/developer.texi: improve the introductory text X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.29 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" X-TUID: WOBhPlxjyIb4 Remove confusing references to "external" vs. "internal" developers. --- doc/developer.texi | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/developer.texi b/doc/developer.texi index addee0d826..5cf3b19ee0 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -10,13 +10,19 @@ @contents -@chapter Notes for external developers +@chapter Introduction -This document is mostly useful for internal FFmpeg developers. -External developers who need to use the API in their application should -refer to the API doxygen documentation in the public headers, and -check the examples in @file{doc/examples} and in the source code to -see how the public API is employed. +This text is concerned with the development @emph{of} FFmpeg itself. Information +on using the FFmpeg libraries in other programs can be found elsewhere, e.g. in: +@itemize @bullet +@item +the installed header files +@item +@url{http://ffmpeg.org/doxygen/trunk/index.html, the Doxygen documentation} +generated from the headers +@item +the examples under @file{doc/examples} +@end itemize You can use the FFmpeg libraries in your commercial program, but you are encouraged to @emph{publish any patch you make}. In this case the