From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.devel Subject: RE: [External] : Re: Convert README.org to plain text README while installing package Date: Mon, 6 Jun 2022 15:10:27 +0000 Message-ID: References: <87leuca7v7.fsf@disroot.org> <87czfopmsd.fsf@gnu.org> <87h74ztshe.fsf@gmx.de> <871qw31ois.fsf@yahoo.com> <8735gj4ceo.fsf@gnu.org> <87sfojz63r.fsf@yahoo.com> <87h74z5nio.fsf@localhost> <87ilpf45mo.fsf@disroot.org> <87ee033w7h.fsf@gnu.org> <87a6ar3rdw.fsf@gnu.org> <87y1yaxmuu.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="24698"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Akib Azmain Turja , Ihor Radchenko , Po Lu , "emacs-devel@gnu.org" , Michael Albinus , Alan Mackenzie , Stefan Kangas To: Tassilo Horn Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Jun 06 18:03:05 2022 Return-path: 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 ) id 1nyFC4-00068O-Gs for ged-emacs-devel@m.gmane-mx.org; Mon, 06 Jun 2022 18:03:04 +0200 Original-Received: from localhost ([::1]:39916 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nyFC3-0005Qg-7v for ged-emacs-devel@m.gmane-mx.org; Mon, 06 Jun 2022 12:03:03 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:59324) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nyENf-00018V-Tx for emacs-devel@gnu.org; Mon, 06 Jun 2022 11:10:59 -0400 Original-Received: from mx0a-00069f02.pphosted.com ([205.220.165.32]:27920) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nyENb-0006U3-8l; Mon, 06 Jun 2022 11:10:59 -0400 Original-Received: from pps.filterd (m0246617.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.17.1.5/8.17.1.5) with ESMTP id 256E7Jdt004886; Mon, 6 Jun 2022 15:10:46 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=from : to : cc : subject : date : message-id : references : in-reply-to : content-type : content-transfer-encoding : mime-version; s=corp-2021-07-09; bh=2PamSD4W41CXFLzVLrK7tLvMXMRUOyaUZUBHyd7tSR0=; b=ht5AH3AjlnfKvaNX5rem8ngd7YEjWWVzi4t2Y5HWdhPj3u6PTwJc+hXICwvshzBiRUXd vMrv0U75sji3p91suoup0W+duVyuXEwFQwr0tcpst+EQ/W21kYorP9dV60jb95EjLcW9 4KOqkHs+zTlGrKbIBN7Io8yAc5vWcZRXeowm+aAArz5rsc1GQLDJItUm9oHf6yipgd7Q U3MHU3AzT8a0HxtxQI8HqB4acu5vcGzFNKsM1XXksJNLDbgIMU7Z0apK97GqzvXAICLu Y5o2T2UZOMl8fqiP65X2EmCeITuuM/1gRSIhtGGJRIaCEUYPsOy56GEMUSYv+IUbB4D9 +Q== Original-Received: from phxpaimrmta02.imrmtpd1.prodappphxaev1.oraclevcn.com (phxpaimrmta02.appoci.oracle.com [147.154.114.232]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3gfyxsbe7g-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 06 Jun 2022 15:10:45 +0000 Original-Received: from pps.filterd (phxpaimrmta02.imrmtpd1.prodappphxaev1.oraclevcn.com [127.0.0.1]) by phxpaimrmta02.imrmtpd1.prodappphxaev1.oraclevcn.com (8.16.1.2/8.16.1.2) with SMTP id 256FAhpV010397; Mon, 6 Jun 2022 15:10:45 GMT Original-Received: from nam12-mw2-obe.outbound.protection.outlook.com (mail-mw2nam12lp2049.outbound.protection.outlook.com [104.47.66.49]) by phxpaimrmta02.imrmtpd1.prodappphxaev1.oraclevcn.com with ESMTP id 3gfwu1mdng-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 06 Jun 2022 15:10:44 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=n9sQRhXqVHp1XKBjGTa5KXkSKERJh1/8+SQEiE3ZLSwkmGEuVjH0ptGoNDrtpXesO4MN2BdePwL+yT802KL/IAupKS5Ph99bbgmJnFdbZoZ/ij9wDz7hx1Reuj8hp0ZaANA/tz3UGdPWNXGhZPERIieukVrTOkQrbxbo7vORFpjeA23YYtApz2aT1Hib+WiT7OlQ/tGdt9BWAhgoQqT0QB/t+pkK+SNNeACdaSj/ot6SbnoccZuPaCKvYfF0RkoRMs0fXSJqowYpUwJebsjTCnjvWC0MtXHHe1zRCbjjMIBDkid0rfg9npaW90jk1w2VPDMk0DLInV0yuGvlu8VM2g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=2PamSD4W41CXFLzVLrK7tLvMXMRUOyaUZUBHyd7tSR0=; b=Wm2vIBkfISMYQ6hyVsy5QGVdOrl8BaZBZYzyhz7tW19wMCV+dfqX0r6OG2gcvA364mMdv7Awjwm8xEa8G2SWZ68l1G5MKTEJxLwCUZUIA+qYoLcz2BQsyb8DYSlppKAXYGKtgs8aEymyzGF1NDFsKCwsDxjGY6icmJL+fLQoVJzj2cQusspHbq9DMXmUbgP6oZrAHCsJHFrr2iTIIbDqjbB7HGlrY+JiN5Eic6OoATg3te34W1sUw9EOYs0pgJso+TR1zrAMbKdxWTsHHEy5ixbM0Qr2Cgok2XED8buPPwQ5CknfS1O7NxEXx8K+G9WOO+gDHtbQrJUr92lU/E08eQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=oracle.com; dmarc=pass action=none header.from=oracle.com; dkim=pass header.d=oracle.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.onmicrosoft.com; s=selector2-oracle-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=2PamSD4W41CXFLzVLrK7tLvMXMRUOyaUZUBHyd7tSR0=; b=x2sYFQ3nT0VQ6dlZcTKUIN0bwJX6aHWScCw9zQbJk3tXHuDQLtpIFPuVBHECUwwXQbB+Up7YasAHgr+TBIPQlx2WNd21cvIMqQN6jyGIDqq2Xob+hJfLlih2oX1p508fScrRyD+F2P7NoKIOGcYxVtHsRlmYX2kaDaaigXVSVSQ= Original-Received: from SJ0PR10MB5488.namprd10.prod.outlook.com (2603:10b6:a03:37e::19) by CY4PR1001MB2118.namprd10.prod.outlook.com (2603:10b6:910:40::35) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5314.13; Mon, 6 Jun 2022 15:10:27 +0000 Original-Received: from SJ0PR10MB5488.namprd10.prod.outlook.com ([fe80::818c:10bf:c1b5:e224]) by SJ0PR10MB5488.namprd10.prod.outlook.com ([fe80::818c:10bf:c1b5:e224%3]) with mapi id 15.20.5314.019; Mon, 6 Jun 2022 15:10:27 +0000 Thread-Topic: [External] : Re: Convert README.org to plain text README while installing package Thread-Index: AQHYeXXy9h1fPduOME6551JRqZ2Y761CcrKA In-Reply-To: <87y1yaxmuu.fsf@gnu.org> Accept-Language: en-US Content-Language: en-US x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 53d764e9-547c-4f9e-26e8-08da47ceb04b x-ms-traffictypediagnostic: CY4PR1001MB2118:EE_ x-microsoft-antispam-prvs: x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: /72cHC3n50Eiq2XrRb5omWvkeFyWOeA0wRFyxtvenhUHHpEznvZT5L1SRxnyNrLYlK47kIwgcSGVG7DzMECsclpLRzIFsBUV6dd2GlZlqcZruyruYvfSdFegMLLFsACCkudsA0Y/BoVFN5iS8trl1ln23qARtqUvWm2UMNLRo2BP7Doj2K2Kx3ZQZGFk6HJxoD2HcFEaAgFRoxZZPKRyJ9GpwkehRSJEcKkGVy4+Y850MlyH7A390mqTlUoYY4cFVcojW9gMawSWwnlxwtXDMOxGOyAg5DrXxoPAEayvzQ0okuOgrz00TlkWqd0TRRKQZWf0tNXlOBa7ZfDtGrWF1Bqh6NvCvhWbhLoEUtVgNowD0H98+g4EfGWfAwK9TqKUwlagrp4CEkK2L/ZmY48owlqkZOZfIrK1CRSEcByAsDDjFryH4FCqSflSlE2fGBgBqcOgi5x//U/v5R3MpdYjpbPgd0tK8B4b6Adq6If3k9YPOaNQhr79LPJy92J9dOh8DNRFeiA4Aw+mrEa+5aL+5vn2yx12V9rI0JGd8G/r1zMrRj7O1bYWnpjZlkjjoCUGVHQNPkt8Yif3hgSqxn4kouhAUO20clxdVp3yxq1UQ85GmzC3lvlmvOEr0mEm/t9EpYbVxKLmRQOJMPH1hPq4XcyZ8ZEMFNNhHfYhAUMLQwoBjdKZVXEXLHpPgoSBlE0bCY3ENA97r/wMq0B66UHVpw== x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SJ0PR10MB5488.namprd10.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230001)(366004)(122000001)(8676002)(66556008)(64756008)(66446008)(33656002)(5660300002)(66476007)(38100700002)(44832011)(4326008)(71200400001)(52536014)(38070700005)(66946007)(76116006)(83380400001)(54906003)(86362001)(6916009)(55016003)(2906002)(6506007)(26005)(316002)(9686003)(7696005)(186003)(508600001)(8936002); DIR:OUT; SFP:1101; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?Qohdqe1uaVArKd8cLRjVLV9/eUOTGAnDHWqT/uPg48uqlfa0kz1HTwlAeELG?= =?us-ascii?Q?viIxizcbUsUov5XS+77QMaa1NSi4yX/QZ4jpqYdDEBhS/2ihyndX+vGJI360?= =?us-ascii?Q?JXnk4LuZDtO83gaEcp1Ey5QyR6AYXd2GXjTEezc0dQxkjKLb9h58IsPG9CJd?= =?us-ascii?Q?aOdzXmbrklMHM3eP9BZFakMZfGfHfHvN7joM1VvsKdGO8PznQr1TJ3kFlB1s?= =?us-ascii?Q?1ERZwxMZ3mWYD0P231nCOgQOQQXTekWYcoA0RN59WEJwgj7fhAvxo9ChIfY8?= =?us-ascii?Q?+OP07ErQvJS2xXhjfkRHorkzgV933IKPuPxB0Updaa6Ey3aylinTutJPb9d7?= =?us-ascii?Q?tsHkmbO2I7PP0+9CAYo9xZ0vaFoonI9/ouSGy7GPP+tjYiU59r7BXmm0AL/t?= =?us-ascii?Q?VblG3DFjqwzi9GSSrh0XnDUqTwAUSoRCfCFlHX9S7lxOYWB7Rl5EN6S108xS?= =?us-ascii?Q?zoGAwH6EjcSXSWzeVUF2ijoTmv83VwX0CZNoJWVFNZjJMq5UgSj8ldrNuSD7?= =?us-ascii?Q?J/TL2UcgNuYIBa7qPgC7wDRyopdenDjYbd2OQHIJoSU9zya4oCLv34lKUnc6?= =?us-ascii?Q?N/2x+FDu4Kw5iV+NdxX7miejMBRqkb4rqO+MgaC+anXRUm28ezCt46SEgxNH?= =?us-ascii?Q?zZ X-OriginatorOrg: oracle.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: SJ0PR10MB5488.namprd10.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 53d764e9-547c-4f9e-26e8-08da47ceb04b X-MS-Exchange-CrossTenant-originalarrivaltime: 06 Jun 2022 15:10:27.2271 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: zrmoMd5t/pjzNtoFmI21d/XoUy9T9mAA/ZTuFQYDHKqpF8M3kqmjoaT1lyVxVFj53hn34n3ozS1nzxUpv6bcSg== X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR1001MB2118 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.517, 18.0.874 definitions=2022-06-06_04:2022-06-02, 2022-06-06 signatures=0 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxlogscore=999 spamscore=0 adultscore=0 suspectscore=0 malwarescore=0 phishscore=0 bulkscore=0 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2204290000 definitions=main-2206060069 X-Proofpoint-ORIG-GUID: yg54GUrr0QmXB08EXtpIo9si-7rQL6ze X-Proofpoint-GUID: yg54GUrr0QmXB08EXtpIo9si-7rQL6ze Received-SPF: pass client-ip=205.220.165.32; envelope-from=drew.adams@oracle.com; helo=mx0a-00069f02.pphosted.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, 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." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:290804 Archived-At: > maybe I didn't understand your suggestion which > sounded to me as if you say that there should be > a mandatory plain-text README to be displayed in > Emacs plus as many "rich" versions as the package > author wants. My suggestion is apparently moot now, as Stefan has already decided what will/won't be done, wrt GNU ELPA. But yes I suggested that a plain README be required. I don't think I said anything about it being displayed. And I'm pretty sure I didn't say anything about any other formats _not_ being displayed. I don't have a set opinion about what should be displayed by default. (I'd hope that, whatever is the default for displaying, users could somehow control what is actually the case.) I did say "required". I later changed the wording to clarify that I meant something more like "requested politely", e.g., Please consider supplying a plain README. > However, those wouldn't be displayed in Emacs. No; see above. I didn't mean to say, and I don't think I said, anything about what gets displayed. Now that you bring that up, I guess my preference would be that package authors can control what gets displayed by default (see above, about users being perhaps able to override the default). But others have brought up the question of needing this or that tool/infrastructure, to be able to display this or that "rich" format. I haven't been focused on the question of display, except to say that it takes very little to be able to read a simple, plain-text readme. My request for including plain README was just to include it, not to display it. Make it available. > Or rather, they would only be displayed when you > find-file them inside ~/.emacs.d/elpa/ which is > quite unlikely to happen (unless the README says > there are also alternative versions of the package > destription available). I hadn't thought about any particular mechanisms for making this or that format available, or displaying one or the other format. My suggestion (concern) was just to try to get authors to (also) include a plain README. > >> Yes, indeed. I haven't seen anything like that for > >> markdown (which is probably even more popular for > >> READMEs than org), though. > > > > Even producing a plain-text version by manual editing > > is likely not a big deal in most cases. That's my > > guess, at least. >=20 > Having to synchronize two identical (wrt. contents) versions of a > document manually, one with markup and one without, is annoying IMO. As I said, the simple, plain README need not have the same content as any more elaborate README.*. Its purpose could be just to let you know something basic about the package - perhaps even including instructions for how to display a more elaborate README.*. To me, a plain README could serve as a minimal place to start, requiring next to no paraphernalia or infrastructure to read it. It need not be long or in any way complete/definitive. It should at least serve as minimal help to get going.