From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Dmitry Gutov Newsgroups: gmane.emacs.devel Subject: Re: Git version of ELPA Date: Sat, 17 Aug 2013 02:04:00 +0300 Message-ID: <520EAFE0.8020408@yandex.ru> References: <8738qs5qrg.fsf@igel.home> <87mwoz4w4f.fsf@igel.home> <877gfrrida.fsf@yandex.ru> <52087DDD.1020100@yandex.ru> <52090C0F.4020508@yandex.ru> <520B4B29.8030201@yandex.ru> <520BB4FA.4080903@yandex.ru> <520BEC92.401@yandex.ru> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1376694265 26610 80.91.229.3 (16 Aug 2013 23:04:25 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 16 Aug 2013 23:04:25 +0000 (UTC) Cc: emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Aug 17 01:04:22 2013 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 1VAT49-00020V-RV for ged-emacs-devel@m.gmane.org; Sat, 17 Aug 2013 01:04:21 +0200 Original-Received: from localhost ([::1]:33430 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VAT49-0002rz-FS for ged-emacs-devel@m.gmane.org; Fri, 16 Aug 2013 19:04:21 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:43416) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VAT42-0002qz-1M for emacs-devel@gnu.org; Fri, 16 Aug 2013 19:04:19 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VAT3u-0001CP-W1 for emacs-devel@gnu.org; Fri, 16 Aug 2013 19:04:13 -0400 Original-Received: from forward3.mail.yandex.net ([77.88.46.8]:37164) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VAT3u-0001CB-MB for emacs-devel@gnu.org; Fri, 16 Aug 2013 19:04:06 -0400 Original-Received: from smtp3.mail.yandex.net (smtp3.mail.yandex.net [77.88.46.103]) by forward3.mail.yandex.net (Yandex) with ESMTP id 97635B417C5; Sat, 17 Aug 2013 03:04:03 +0400 (MSK) Original-Received: from smtp3.mail.yandex.net (localhost [127.0.0.1]) by smtp3.mail.yandex.net (Yandex) with ESMTP id 6442D1BA092A; Sat, 17 Aug 2013 03:04:03 +0400 (MSK) Original-Received: from 62-107-247.netrun.cytanet.com.cy (62-107-247.netrun.cytanet.com.cy [62.228.107.247]) by smtp3.mail.yandex.net (nwsmtp/Yandex) with ESMTP id 0D2VHtCwWY-42fWtRHF; Sat, 17 Aug 2013 03:04:02 +0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yandex.ru; s=mail; t=1376694242; bh=ytx1fpPVznF9BkpoMgRfMosvoYNOtSj66Tc64c6M1xY=; h=Message-ID:Date:From:User-Agent:MIME-Version:To:CC:Subject: References:In-Reply-To:Content-Type:Content-Transfer-Encoding; b=BZ5ATbFku2zeGJF9JVAeXvrVi3Z5VYjSHxzRzlrDZzGI+EVhXgQfS5HdDdMZr8Wfa 36AFmn8/XLX40b/O8OGi6KH3VFQuZJ9v1xsrqXAJ/rVJrqum7Qgo0vHTKZCso84hiP KeWvSA7EeHr/XaccDO+d//xgwy1qMnidWSjuUThU= Authentication-Results: smtp3.mail.yandex.net; dkim=pass header.i=@yandex.ru User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130803 Thunderbird/17.0.8 In-Reply-To: <520BEC92.401@yandex.ru> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] [fuzzy] X-Received-From: 77.88.46.8 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:162833 Archived-At: On 14.08.2013 23:46, Dmitry Gutov wrote: > Speaking of README file formats, maybe your current solution is good > enough. The Melpa guys have intentionally settled on the same approach > (use the Commentary from .el): > > https://github.com/milkypostman/melpa/issues/522 > https://github.com/milkypostman/melpa/pull/366 > > The idea is that README.md/org/etc in the root of the directory serves > as an introduction, and it usually contains a section "how to install". > > The package description buffer, on the other hand, would be most useful > if it has a short description of what the package is about and how to > use it *once it's installed*. Cases in point: http://elpa.gnu.org/packages/ggtags.html http://elpa.gnu.org/packages/ack.html http://elpa.gnu.org/packages/js2-mode.html link to http://elpa.gnu.org/ and mention M-x list-packages, both of which are somewhat extraneous. http://elpa.gnu.org/packages/coffee-mode.html recommends cloning from GitHub and installing manually. http://elpa.gnu.org/packages/company.html avoids this problem largely accidentally, by having a homepage separate from the GitHub repo (which is relatively unusual). Insidentally, this change (de728884) also broke the link from js2-mode's README.md to http://elpa.gnu.org/packages/js2-mode.html, because the surrounding text depends on the latter page having the description from Commentary. But no matter, that happens.