From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <ffmpeg-devel-bounces@ffmpeg.org>
Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100])
by master.gitmailbox.com (Postfix) with ESMTP id DA4DB44C35
for <ffmpegdev@gitmailbox.com>; Mon, 14 Nov 2022 09:13:35 +0000 (UTC)
Received: from [127.0.1.1] (localhost [127.0.0.1])
by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id C7C5968BD5C;
Mon, 14 Nov 2022 11:13:32 +0200 (EET)
Received: from mail0.khirnov.net (red.khirnov.net [176.97.15.12])
by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 38258689993
for <ffmpeg-devel@ffmpeg.org>; 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 <ffmpeg-devel@ffmpeg.org>; 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 <ffmpeg-devel@ffmpeg.org>;
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 <ffmpeg-devel@ffmpeg.org>; 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 <ffmpeg-devel@ffmpeg.org>; Mon, 14 Nov 2022 10:13:17 +0100 (CET)
From: Anton Khirnov <anton@khirnov.net>
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 <ffmpeg-devel.ffmpeg.org>
List-Unsubscribe: <https://ffmpeg.org/mailman/options/ffmpeg-devel>,
<mailto:ffmpeg-devel-request@ffmpeg.org?subject=unsubscribe>
List-Archive: <https://ffmpeg.org/pipermail/ffmpeg-devel>
List-Post: <mailto:ffmpeg-devel@ffmpeg.org>
List-Help: <mailto:ffmpeg-devel-request@ffmpeg.org?subject=help>
List-Subscribe: <https://ffmpeg.org/mailman/listinfo/ffmpeg-devel>,
<mailto:ffmpeg-devel-request@ffmpeg.org?subject=subscribe>
Reply-To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: ffmpeg-devel-bounces@ffmpeg.org
Sender: "ffmpeg-devel" <ffmpeg-devel-bounces@ffmpeg.org>
Archived-At: <https://master.gitmailbox.com/ffmpegdev/20221114091309.15755-1-anton@khirnov.net/>
List-Archive: <https://master.gitmailbox.com/ffmpegdev/>
List-Post: <mailto:ffmpegdev@gitmailbox.com>
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
--
2.35.1
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".