Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
 help / color / mirror / Atom feed
From: Anton Khirnov <anton@khirnov.net>
To: ffmpeg-devel@ffmpeg.org
Subject: [FFmpeg-devel] [PATCH 1/4] doc/developer.texi: improve the introductory text
Date: Mon, 14 Nov 2022 10:13:06 +0100
Message-ID: <20221114091309.15755-1-anton@khirnov.net> (raw)

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".

             reply	other threads:[~2022-11-14  9:13 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-14  9:13 Anton Khirnov [this message]
2022-11-14  9:13 ` [FFmpeg-devel] [PATCH 2/4] doc/developer.texi: extend the argument for submitting patches Anton Khirnov
2022-11-14  9:35   ` Soft Works
2022-11-14  9:53   ` Anton Khirnov
2022-11-14 10:46     ` Soft Works
2022-11-14 11:07   ` Anton Khirnov
2022-11-14 11:20     ` Soft Works
2022-11-14 11:40     ` Soft Works
2022-11-14 12:42     ` Nicolas George
2022-11-14 14:34     ` Anton Khirnov
2022-11-14 15:13       ` Soft Works
2022-11-14 15:18         ` Paul B Mahol
2022-11-14 15:39           ` Soft Works
2022-11-14 15:45           ` Soft Works
2022-11-14 16:13       ` Anton Khirnov
2022-11-14 16:38         ` Soft Works
2022-11-14 16:40           ` Nicolas George
2022-11-14 17:25             ` Soft Works
2022-11-14 17:47               ` Nicolas George
2022-11-14 22:05         ` Michael Niedermayer
2022-11-14 22:49           ` Soft Works
2022-11-14  9:13 ` [FFmpeg-devel] [PATCH 3/4] doc/developer.texi: demote the "contributing" chapter to a section Anton Khirnov
2022-11-14  9:13 ` [FFmpeg-devel] [PATCH 4/4] doc/developer.texi: refine the "contributing code" section Anton Khirnov

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20221114091309.15755-1-anton@khirnov.net \
    --to=anton@khirnov.net \
    --cc=ffmpeg-devel@ffmpeg.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://master.gitmailbox.com/ffmpegdev/0 ffmpegdev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 ffmpegdev ffmpegdev/ https://master.gitmailbox.com/ffmpegdev \
		ffmpegdev@gitmailbox.com
	public-inbox-index ffmpegdev

Example config snippet for mirrors.


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git