From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by master.gitmailbox.com (Postfix) with ESMTP id 96AE94A10D for ; Sat, 20 Apr 2024 16:13:58 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 34F5A68CF14; Sat, 20 Apr 2024 19:13:55 +0300 (EEST) Received: from mail-wr1-f45.google.com (mail-wr1-f45.google.com [209.85.221.45]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 8D91468D180 for ; Sat, 20 Apr 2024 19:13:48 +0300 (EEST) Received: by mail-wr1-f45.google.com with SMTP id ffacd0b85a97d-349c5732fd1so2784202f8f.3 for ; Sat, 20 Apr 2024 09:13:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1713629626; x=1714234426; darn=ffmpeg.org; h=user-agent:in-reply-to:content-transfer-encoding :content-disposition:mime-version:references:mail-followup-to :message-id:subject:to:from:date:from:to:cc:subject:date:message-id :reply-to; bh=P5yWwPnc9q5V7+36mzF+ea8C7cWp+qfrHmNfM2bEmX0=; b=ekQrXs3/SJ+GiwXml+3lhvDKkQLw0aruqftg8goUcXIifV9MDeui7JNpWWwfZiK+Ch +hGFHzeTR/w2n+MxNvrDk+GBdYOBZmzMKZaR8i/4qkF6k1ONdwIy7u8vyk67o8nvddzX 80rsHaeD8chjXpCKj21FB65BomCuLLTtqQaT37LOJV/kjttrHhOQr8zR4KT/VgqVUzt8 fKDsJD+Zl0OVz5C/bMceLwmcG8vXebDzY8mX89M5zUKZNm/zr49qKcKNCavuJSH5Vo4v Ulf6nHjNj91NGeOtA+arlqFfZK+Z35viosUH/NfojNOBoMmiIsOsLVlrwCNcttW+0AiF WMjg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1713629626; x=1714234426; h=user-agent:in-reply-to:content-transfer-encoding :content-disposition:mime-version:references:mail-followup-to :message-id:subject:to:from:date:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=P5yWwPnc9q5V7+36mzF+ea8C7cWp+qfrHmNfM2bEmX0=; b=SsEJbTEWuLwSsvaecz8aesnGqkjnFUtv4pMIzcMoCJ9u4fCym6CfY++Y4eIOOY+/im NxvVwiifrB7CZ44qFQ1TRR34S2TBTfAEWMzkBNz5AHM6nGePrOWzCIvrbiDY1Gu6jgCQ B39T69e6OPf7gfgP0Un1znxCrp2/0EzkBqUqAlvz4bWPLjdR+uZMffyWHe8M8kyzed3X yt8RsIo2c3Mn9BYQWwtXZ2A7CDKwCHmkFCOzEx9UUdz1IdHAr79KVnMtaV+L+tdgQrCd TBmT9HX4IJ2cQtXt/GrzubfAFl+M2xt50X2FJ5OVXJTXXvcE+kY121jwnsZTeVsV0GX0 PCig== X-Gm-Message-State: AOJu0YwLmTodZ0BwEjZSnxoWNKcvzOUOeA/l7HwHEWS94lkVY6QVbXGB 7mj117X+LUMVsfCHYNjb+5D23ktUJRewbdCMrP+3MELCIIlCYrzv011cmg== X-Google-Smtp-Source: AGHT+IF2go4jUtJs1Qtgr4u28G0uShWi7W8vrEDJFZ6amRH4lQn7+Iyi01qD/19d5oBW6G0AB6oA0w== X-Received: by 2002:a5d:6b49:0:b0:34a:35c7:22a3 with SMTP id x9-20020a5d6b49000000b0034a35c722a3mr4167916wrw.20.1713629626409; Sat, 20 Apr 2024 09:13:46 -0700 (PDT) Received: from mariano (host-87-17-49-61.retail.telecomitalia.it. [87.17.49.61]) by smtp.gmail.com with ESMTPSA id a7-20020a170906670700b00a522bef9f06sm3541940ejp.181.2024.04.20.09.13.45 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 20 Apr 2024 09:13:45 -0700 (PDT) Received: by mariano (Postfix, from userid 1000) id B4865BFCE8; Sat, 20 Apr 2024 18:13:44 +0200 (CEST) Date: Sat, 20 Apr 2024 18:13:44 +0200 From: Stefano Sabatini To: FFmpeg development discussions and patches Message-ID: Mail-Followup-To: FFmpeg development discussions and patches References: <20240418150614.3952107-1-ffmpeg-devel@pileofstuff.org> <8c349687-9bba-41f6-afdb-2835ef29f34d@pileofstuff.org> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <8c349687-9bba-41f6-afdb-2835ef29f34d@pileofstuff.org> User-Agent: Mutt/2.1.4 (2021-12-11) Subject: Re: [FFmpeg-devel] [PATCH 1/3] doc: Explain what "context" means 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 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Archived-At: List-Archive: List-Post: On date Saturday 2024-04-20 13:18:29 +0100, Andrew Sayers wrote: > On 20/04/2024 08:25, Stefano Sabatini wrote: > > On date Thursday 2024-04-18 16:06:12 +0100, Andrew Sayers wrote: > > > Based largely on the explanation by Stefano Sabatini: > > > https://ffmpeg.org/pipermail/ffmpeg-devel/2024-April/325854.html > > > --- > > > doc/jargon.md | 96 ++++++++++++++++++++++++++++++++++++++++++++++++= +++ > > > 1 file changed, 96 insertions(+) > > > create mode 100644 doc/jargon.md > > > = > > > diff --git a/doc/jargon.md b/doc/jargon.md > > > new file mode 100644 > > > index 0000000000..3b78ffb61f > > > --- /dev/null > > > +++ b/doc/jargon.md > > We currently have a single .md file in doc (for historical reason we > > still stick to texinfo). Also how is this integrated into doxygen? > = > Doxygen automatically renders all /*.md and /doc/*.md files to pages at [= 1] > which is the only place I'd know to look for this sort of thing. it seems > like texinfo is more for man pages etc., which would be hard to link from > doxygen?=A0 By the way, a file called "jargon" seemed like a better idea = than > e.g. a "design_patterns" file or a section in AVClass.=A0 I've rewritten = the > document completely based on your feedback - same markdown file for now, > but happy to move/reformat. If this is the case, probably we should move the files to a dedicated directory (doxygen?) to avoid to mix too many things in the same bundle (can be done as a separated patch though since we might think about what we really want to include in the doxygen docs). > The points below should be addressed by the new patch, so I'll let that > speak for itself.=A0 But there's a general issue that's worth mentioning.= .. > = > Technically, it sounds like a more accurate description would be "Context > is an FFmpeg convention that has become fairly rigorous over the years". > But IMHO readers would uncharitably read that as "Context is some weird > FFmpeg thing they're stuck with because they picked a pre-OOP language". > Arguing "Context is a design pattern that groups objects by lifespan" > emphasises the lessons a newbie can take from FFmpeg and use elsewhere, > so they get more value from the time they spent reading the document. > I've tried to write the document to start with the more useful argument, > then gradually ease in to the more accurate one. But, I don't think this is really something very rigourous, because it is used in different "contexts" with sligthly different features (e.g. you can have a structure named "context" but without an AVClass or options). And it's not really about lifespan, and not really specific for FFmpeg, in C programming this is used to provide a "context" for several "methods" operating on a given struct - so basically a light implementation of an object-oriented-based API. [...] _______________________________________________ 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".