From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Evgeny M. Zubok" Newsgroups: gmane.emacs.devel Subject: Re: Policy for documentation of ELPA Date: Sun, 17 Jul 2011 13:37:50 +0400 Message-ID: <877h7h458x.fsf@tochka.ru> References: <87sjq9lvps.fsf@tochka.ru> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: dough.gmane.org 1310895582 17763 80.91.229.12 (17 Jul 2011 09:39:42 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Sun, 17 Jul 2011 09:39:42 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Jul 17 11:39:39 2011 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1QiNp4-0003Fq-E7 for ged-emacs-devel@m.gmane.org; Sun, 17 Jul 2011 11:39:38 +0200 Original-Received: from localhost ([::1]:34605 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QiNp3-0004JL-Nk for ged-emacs-devel@m.gmane.org; Sun, 17 Jul 2011 05:39:37 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:47291) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QiNom-0004Iu-Ls for emacs-devel@gnu.org; Sun, 17 Jul 2011 05:39:21 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QiNol-0005Fk-05 for emacs-devel@gnu.org; Sun, 17 Jul 2011 05:39:20 -0400 Original-Received: from lo.gmane.org ([80.91.229.12]:48700) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QiNok-0005FY-Kl for emacs-devel@gnu.org; Sun, 17 Jul 2011 05:39:18 -0400 Original-Received: from list by lo.gmane.org with local (Exim 4.69) (envelope-from ) id 1QiNoi-00036K-Tf for emacs-devel@gnu.org; Sun, 17 Jul 2011 11:39:16 +0200 Original-Received: from 91.79.137.227 ([91.79.137.227]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 17 Jul 2011 11:39:16 +0200 Original-Received: from evgeny.zubok by 91.79.137.227 with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 17 Jul 2011 11:39:16 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 25 Original-X-Complaints-To: usenet@dough.gmane.org X-Gmane-NNTP-Posting-Host: 91.79.137.227 User-Agent: Gnus/5.11 (Gnus v5.11) Emacs/22.2 (gnu/linux) Cancel-Lock: sha1:PkTOXJeF+FNjC8iTtXI/VzPaaAI= X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 80.91.229.12 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:142064 Archived-At: Stefan Monnier writes: >> I have written documentation (an initial version) for one of the ELPA >> package. The source is the texinfo file. I see that auctex provides the >> documentation as exported .info file along with Postscript and PDF in >> ./doc directory. Muse also provides the .info file. No package that >> provides source of documentation (texinfo files, PostScript diagrams and >> figures, etc). What is the current (if any) policy for documentation? >> Should the package also contain sources, just in case if someone want to >> improve the documentation? > > It should definitely contain the source (in this case the Texinfo) if at > all possible. And what about the documentation in compiled format? org-mode and muse have its own upstream development and they keep the documentation sources there. The developers commit only user-readable documentation into ELPA and they don't commit the texinfo. `debbugs' uses ELPA for development. So, we have no other option than to store texinfo file in ELPA. No problem. The main question is about the documentation in human readable format. ELPA contains the files as they will be installed at user side, right? Should I manually re-generate the final documentation every time I have made even the little change in texinfo file? Can I do it not very often? Where the documentation should arrive when the user installs the ELPA package?