From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: =?utf-8?Q?=C3=93scar_Fuentes?= Newsgroups: gmane.emacs.devel Subject: Re: good examples of Emacs modules? Date: Thu, 31 Mar 2016 17:34:03 +0200 Message-ID: <8737r67jbo.fsf@wanadoo.es> References: <56FC5E99.7090804@cs.ucla.edu> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Trace: ger.gmane.org 1459438484 21524 80.91.229.3 (31 Mar 2016 15:34:44 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 31 Mar 2016 15:34:44 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Mar 31 17:34:34 2016 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1alecE-0001tN-LX for ged-emacs-devel@m.gmane.org; Thu, 31 Mar 2016 17:34:34 +0200 Original-Received: from localhost ([::1]:32902 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1alecE-0008GP-3d for ged-emacs-devel@m.gmane.org; Thu, 31 Mar 2016 11:34:34 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:41878) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1alebz-0008GB-PS for emacs-devel@gnu.org; Thu, 31 Mar 2016 11:34:20 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1alebu-0008Jx-QJ for emacs-devel@gnu.org; Thu, 31 Mar 2016 11:34:19 -0400 Original-Received: from plane.gmane.org ([80.91.229.3]:40920) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1alebu-0008Jf-Jx for emacs-devel@gnu.org; Thu, 31 Mar 2016 11:34:14 -0400 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1alebr-0001kj-Nd for emacs-devel@gnu.org; Thu, 31 Mar 2016 17:34:11 +0200 Original-Received: from 151.red-79-153-146.dynamicip.rima-tde.net ([79.153.146.151]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Thu, 31 Mar 2016 17:34:11 +0200 Original-Received: from ofv by 151.red-79-153-146.dynamicip.rima-tde.net with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Thu, 31 Mar 2016 17:34:11 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 21 Original-X-Complaints-To: usenet@ger.gmane.org X-Gmane-NNTP-Posting-Host: 151.red-79-153-146.dynamicip.rima-tde.net User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.0.92 (gnu/linux) Cancel-Lock: sha1:BOgfOBbSz89uqBONHry6b+7Sxoo= X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 80.91.229.3 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:202505 Archived-At: Aurélien Aptel writes: > I'm in the process of writing an introduction. You can find a draft here: > > http://diobla.info/blog-archive/modules-tut.html > > It should get them started. Thanks for working on this. I'm considering a module for using libgit2 from Emacs, but passing data structures around and the creation, storage and disposal of long-lived data (sessions, etc) looks a bit daunting. Some documentation would help a lot. > Everything else is documented in the emacs-module.h header. The documentation on that file is scant, to say it lightly. We need high level descriptions of the APIs, with examples, if possible. Then, a chapter on techniques and recommended strategies for creating and using modules that reflect common C API designs. Whithout that, the real job is not creating a module for libfoo, but figuring out how emacs modules are supposed to work.