From mboxrd@z Thu Jan  1 00:00:00 1970
Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail
From: Stefan Monnier <monnier@iro.umontreal.ca>
Newsgroups: gmane.emacs.devel
Subject: Re: Convert README.org to plain text README while installing package
Date: Tue, 07 Jun 2022 08:27:08 -0400
Message-ID: <jwvh74wllig.fsf-monnier+emacs@gnu.org>
References: <YptplqisiNHbjpsJ@ACM>
 <CADwFkm=6_xP6zRSkDP1kreMKCXGBmp8Ze2WtUMeqq9-gEuGcxw@mail.gmail.com>
 <YpuV9DKe9kzNt5np@ACM> <87h74ztshe.fsf@gmx.de>
 <871qw31ois.fsf@yahoo.com> <8735gj4ceo.fsf@gnu.org>
 <87ee038ipt.fsf@gmx.de> <87o7z61v59.fsf@gmail.com>
 <Yp3l+rjJ0mAIcVZJ@ACM> <87bkv527p5.fsf@gmail.com>
 <Yp5TTb2C6CCXqUvT@ACM> <87ilpc9288.fsf@protesilaos.com>
Mime-Version: 1.0
Content-Type: text/plain
Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214";
	logging-data="14087"; mail-complaints-to="usenet@ciao.gmane.io"
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux)
Cc: Alan Mackenzie <acm@muc.de>,  Tim Cross <theophilusx@gmail.com>,
 emacs-devel@gnu.org
To: Protesilaos Stavrou <info@protesilaos.com>
Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Jun 07 15:12:04 2022
Return-path: <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>
Envelope-to: ged-emacs-devel@m.gmane-mx.org
Original-Received: from lists.gnu.org ([209.51.188.17])
	by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>)
	id 1nyZ06-0003MG-F9
	for ged-emacs-devel@m.gmane-mx.org; Tue, 07 Jun 2022 15:12:02 +0200
Original-Received: from localhost ([::1]:55762 helo=lists1p.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.90_1)
	(envelope-from <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>)
	id 1nyZ05-0004qD-9t
	for ged-emacs-devel@m.gmane-mx.org; Tue, 07 Jun 2022 09:12:01 -0400
Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:59710)
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <monnier@iro.umontreal.ca>)
 id 1nyYIn-0003x8-9M
 for emacs-devel@gnu.org; Tue, 07 Jun 2022 08:27:17 -0400
Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:11066)
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <monnier@iro.umontreal.ca>)
 id 1nyYIk-0000VO-BV
 for emacs-devel@gnu.org; Tue, 07 Jun 2022 08:27:16 -0400
Original-Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1])
 by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id 961B44426C8;
 Tue,  7 Jun 2022 08:27:11 -0400 (EDT)
Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1])
 by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id 1F5A24426C5;
 Tue,  7 Jun 2022 08:27:10 -0400 (EDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca;
 s=mail; t=1654604830;
 bh=LWCZZ+HCvMWuV/fb1Qa+W3i6L/tcl22xoWHqBl/2X9g=;
 h=From:To:Cc:Subject:References:Date:In-Reply-To:From;
 b=aKLmuSrqkoT0TViaD4LdkC5rQ3UEkDarenukGjrsMDCo5HZdN8CviWe5tNv0GbMbP
 NxOxP+D9z6I9Ty8ATpUAImR7vnnyMyC1tq8y/f6vdeePmuMoBW9WHF+XcNrEoj/gQF
 2AcbRCHrPG0SQZhOU56LGHvh9xJ+p2ikWBkOplRJUP4fjTJcdiHeJtfOCQ01fTGzcR
 DQvlZ5LlRRbTmmaSQibevps4YdPTVRbHifR6QHDMbwiUYaq8XRXlafZie+jRr2TQnb
 dTBLqLj1xK8CLegnF0vC5f1Qk60EflHnW7fY72ulZrk0V11semAr2l544iNWygRWP8
 n7JHTNQGmDIIg==
Original-Received: from pastel (unknown [45.72.221.51])
 by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id CEF9A12049B;
 Tue,  7 Jun 2022 08:27:09 -0400 (EDT)
In-Reply-To: <87ilpc9288.fsf@protesilaos.com> (Protesilaos Stavrou's message
 of "Tue, 07 Jun 2022 13:50:31 +0300")
Received-SPF: pass client-ip=132.204.25.50;
 envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca
X-Spam_score_int: -42
X-Spam_score: -4.3
X-Spam_bar: ----
X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3,
 SPF_HELO_NONE=0.001, SPF_PASS=-0.001,
 T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-BeenThere: emacs-devel@gnu.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Emacs development discussions." <emacs-devel.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-devel>,
 <mailto:emacs-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/emacs-devel>
List-Post: <mailto:emacs-devel@gnu.org>
List-Help: <mailto:emacs-devel-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-devel>,
 <mailto:emacs-devel-request@gnu.org?subject=subscribe>
Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org
Original-Sender: "Emacs-devel"
 <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>
Xref: news.gmane.io gmane.emacs.devel:290860
Archived-At: <http://permalink.gmane.org/gmane.emacs.devel/290860>

> Concerning point 2, the GNU ELPA machinery converts the Org source into
> an Info file.  (Those who install the package can access it with C-h i.)
> While I handle the export process into HTML.

Side note: elpa.gnu.org also converts the docs to HTML (both for Org
and for Texinfo docs), and puts a link to it under "Manual" as can be
seen on http://elpa.gnu.org/packages/modus-themes.html

[ This HTML isn't ideal, admittedly.  Help welcome.  ]

> This arrangement provides two viable options for users who (i) want to
> read the documentation yet (ii) do not wish to load org.el and its
> accoutrements.  A third option, in the form of a plain README, is a
> useful addition, provided it is done automatically by GNU ELPA.

I have the impression that there's a bit of misunderstanding here.  There
are two pieces of "docs" that elpa.gnu.org handles: the `:readme` and
the `:doc`.  One is meant for an actual manual that can be browsed with Info,
while the other is expected to be a short blurb, to help prospective
users understand what the package is about.
Both accept the Org format, but the `:doc` does not accept "plain text"
(nor Markdown).

Many packages currently use the same file for both (typically called
`README.org`), which tends to be suboptimal (it's often neither a great
`:readme` nor a great `:doc`), but works fine.


        Stefan