From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Chong Yidong Newsgroups: gmane.emacs.devel Subject: Re: document package.el Date: Sun, 08 Aug 2010 19:06:24 -0400 Message-ID: <878w4g66xb.fsf@stupidchicken.com> References: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: dough.gmane.org 1281308809 24307 80.91.229.12 (8 Aug 2010 23:06:49 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Sun, 8 Aug 2010 23:06:49 +0000 (UTC) Cc: Emacs discussions To: Tom Tromey Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Aug 09 01:06:47 2010 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1OiEx0-000783-Fa for ged-emacs-devel@m.gmane.org; Mon, 09 Aug 2010 01:06:43 +0200 Original-Received: from localhost ([127.0.0.1]:53179 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OiEwv-0004Ym-9t for ged-emacs-devel@m.gmane.org; Sun, 08 Aug 2010 19:06:37 -0400 Original-Received: from [140.186.70.92] (port=52690 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OiEwp-0004Yg-L2 for emacs-devel@gnu.org; Sun, 08 Aug 2010 19:06:32 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OiEwk-0004lo-DF for emacs-devel@gnu.org; Sun, 08 Aug 2010 19:06:31 -0400 Original-Received: from pantheon-po41.its.yale.edu ([130.132.50.98]:33088) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OiEwk-0004lc-7Z for emacs-devel@gnu.org; Sun, 08 Aug 2010 19:06:26 -0400 Original-Received: from furry (173-9-75-145-NewEngland.hfc.comcastbusiness.net [173.9.75.145]) (authenticated bits=0) by pantheon-po41.its.yale.edu (8.12.11.20060308/8.12.11) with ESMTP id o78N6ObN011913 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NOT); Sun, 8 Aug 2010 19:06:25 -0400 Original-Received: by furry (Postfix, from userid 1000) id DA7F1C013; Sun, 8 Aug 2010 19:06:24 -0400 (EDT) In-Reply-To: (Tom Tromey's message of "Fri, 06 Aug 2010 16:42:54 -0600") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (gnu/linux) X-YaleITSMailFilter: Version 1.2c (attachment(s) not renamed) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4-2.6 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:128437 Archived-At: Tom Tromey writes: > + A @dfn{package} is simply one or more files, formatted and bundled > +in a particular way. Typically a package includes primarily Emacs > +Lisp code, but it is possible to create other kinds of packages as > +well, for example, a package consisting solely of documentation. I don't think the documentation-only use case is important to mention. Just say that you can include stuff other than Emacs Lisp code, such as Info files. > +This is shown to the user in the package menu buffer. It is just a > +single line. We should probably recommend a stronger length limit. By default, there are only 36 characters in the package buffer. > +Emacs Lisp library header conventions. See @xref{Library Headers}. Omit the "See", as it would produce "See see Library Headers". > + The name of the package is the same as the base name of the > +@file{.el} file, as written in the first comment line. Give an example here. > + A multi-file package is just a @file{.tar} file. BTW, this is off-topic, but I've been meaning to ask why you don't use .tar.gz files. Is the bandwidth difference insignificant? > +@file{superfrobnicator-pkg.el}. This file must have a single form in > +it, a call to @code{define-package}. The package dependencies and You should add a @defun for `define-package'. > +@item Package-Version > ... > +@item Package-Requires In these list items, you should add xrefs to the packaging node.