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: Sun, 5 Jun 2022 17:46:32 +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> 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="30471"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Ihor Radchenko , Po Lu , Michael Albinus , Alan Mackenzie , Stefan Kangas , "emacs-devel@gnu.org" To: Tassilo Horn , Akib Azmain Turja Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jun 05 19:48:58 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 1nxuN0-0007lK-7B for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 19:48:58 +0200 Original-Received: from localhost ([::1]:48910 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nxuMy-00081h-Kk for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 13:48:56 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:58394) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxuKw-0006uX-GG for emacs-devel@gnu.org; Sun, 05 Jun 2022 13:46:50 -0400 Original-Received: from mx0a-00069f02.pphosted.com ([205.220.165.32]:37088) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxuKs-0004qM-O2; Sun, 05 Jun 2022 13:46:50 -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 255GlSNI004649; Sun, 5 Jun 2022 17:46:37 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=CcWe7v9bicDkRVfb0yTniGW/F4JsLZ9+b+bSebJKXHk=; b=FAEPz3JtlaNhFZmYJLJ4JHAluBmCo7y2hJEC5ydF3HauN4RBew6a0dcBVTRZFmKonRzj dKui8ATIu8jLYET4W/v/Se71JRACF6RoKfup9628HHD6TPN3ZnmV6zCo6xXIvBKbXwdc Qv/X9q7y5OkBoGEvPbIz943dp0488bTQgUvHSDRn3SNAIWHcN7p2TyBvVUoq1vXZ49x/ XkFOtqiFqkzT8uu8vaNbfiz15FdWOEWD6WQdF8EhWSA1bumg3UBMLBooZwLyr4KDXr5j xNjenYacy6kaW4OSZk86IPbff2l2Q1VdwqC/0xtn2icv90AlCYn2COMMDJUeXuIQxLy0 cA== Original-Received: from iadpaimrmta02.imrmtpd1.prodappiadaev1.oraclevcn.com (iadpaimrmta02.appoci.oracle.com [147.154.18.20]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3gfyxs9nj7-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Sun, 05 Jun 2022 17:46:36 +0000 Original-Received: from pps.filterd (iadpaimrmta02.imrmtpd1.prodappiadaev1.oraclevcn.com [127.0.0.1]) by iadpaimrmta02.imrmtpd1.prodappiadaev1.oraclevcn.com (8.16.1.2/8.16.1.2) with SMTP id 255HjCo2007221; Sun, 5 Jun 2022 17:46:35 GMT Original-Received: from nam12-mw2-obe.outbound.protection.outlook.com (mail-mw2nam12lp2040.outbound.protection.outlook.com [104.47.66.40]) by iadpaimrmta02.imrmtpd1.prodappiadaev1.oraclevcn.com with ESMTP id 3gfwu7td5p-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Sun, 05 Jun 2022 17:46:35 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=aqUp8z7EVobS3SjmxRzrgYD2dX5GqmRO2mU/85TtkAS0RGuspjfq9bWiYg6KD7AmtO9MCnsfAROSk7NFw1/l8d4e4eqMbX1bjL3qOAgOjAdBGGnqWPS2lKQ0VJS3SxYOOZupY4XjfHIEXrgOdCbLsrgI8YOkcSGwW0QN6rA2ajjpv598kbxSmL1yuSEncbiQ/mFsBTmZ8YLlbk696GgxjM919i5m9mI5YHe/BGV8mv7AhslZ7fywtWT+gxvjeF7UDY9P1q6l8bUOL2lryw6sarhyxzlPQV/PFSXCeNfnTmOFJ68qr0KgdBF+QOjI1Poh4AGQI8xD7nkTOQjMp8Oa8g== 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=CcWe7v9bicDkRVfb0yTniGW/F4JsLZ9+b+bSebJKXHk=; b=lCbmV6na4mrv4uNZNAUmiIu9U4IPvCG4YpCB3DOqAArmBmyLIQajCNSwevb9NdY9Kloh4UM9Hi6fGDG6Jui5yaeByuKKMZGDOM6cOM0DXc+H05H8jQfxZRGL5ODg9VF7NJFuHmgA3qDgPKFU0P5+zbU3gw1YrmlwjDNb6C0hPUJtdCKydL0dJa6SA2q6cHnN4iAqmIcaQKHz2+8vlsRnbuKUgOhqmcJpwKxOYY453YKeLKSuWfOGAY2PaP9BYRKjrhVrQhrbC1cnYlZRIsLzc3tT/FmGAW3D0EKpnzK36C29zlTtFY9xT5srTFyb7nN1orbweKcYVe5Db7yLvsYnFg== 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=CcWe7v9bicDkRVfb0yTniGW/F4JsLZ9+b+bSebJKXHk=; b=vM3r3f9khytmEf/0Wvtd7c2gpk5u6r5jNwbQ+eW4V21zfcLipViqGwQYvg2ZwmNF83Chk99yXCxTkNKqxoWHZo7bd/SxgfCjcR1LFbgO/gK4dbMHmTqZvWOtDS/qmv1/ilhf+LFnt48i4R3NDrQdGbLhOCaZWPGqCsutS9oPikw= Original-Received: from SJ0PR10MB5488.namprd10.prod.outlook.com (2603:10b6:a03:37e::19) by BL0PR10MB2836.namprd10.prod.outlook.com (2603:10b6:208:75::26) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5314.13; Sun, 5 Jun 2022 17:46:32 +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.018; Sun, 5 Jun 2022 17:46:32 +0000 Thread-Topic: [External] : Re: Convert README.org to plain text README while installing package Thread-Index: AQHYePF/9h1fPduOME6551JRqZ2Y761BE0rA In-Reply-To: <87ee033w7h.fsf@gnu.org> Accept-Language: en-US Content-Language: en-US x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 6da4fc77-5b17-4c16-a0b6-08da471b5423 x-ms-traffictypediagnostic: BL0PR10MB2836: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: SW2cZ6MgO3fkomeiMA97kIegfPyqWAqwnO7fpGdmMMs8bI1SYjE2VKgudcFLlyclKTLriDpp8DL3rmSZWS8yeuWYGGVIJ9ft1bvTviecCcsWX9M3SaSWBHHhN495eppQP2CKSfIi6Vs1IkY6dyar2+oV0naeiJKEW4DeaN9mVIZSUwd9WEFxpdohWjoFKEsGlKNj4Am58yzlVcPQ+NeoRSi4tKinEpTYpWEoF7eoqNb6Gt3Hp5cJLGnSRWj6mmyhrp+6q+7FDqsipYHxUZ+wEFsmxbDXVqR1Jgyt3xnyWQ4vyUmD6WkHEiVG4AO3O5m7BRKA0l9dViU/YLIzXc8frAWz6X3fQzYMmxUUdkj5znkGoNcv/Xwkr6WFJ7n3GJwldn1mV72UQ2DlbXLL2vjX8w8F1rQ8m8iq5UMXXcOBNXieULVrK+Evu9yA4CIOIHb6a7vkO1lsK57cluPfGhDQVveKF56NxPK8ZK4CTt2+bwkc3EFpSRR/2IdeMVrm/IScJPHxFAvjz79B+tMgzvgAgScGZ+voWE167Asw+NgL97iLxEWHJqGLbnqTigWZj9i5iw7Xis4S0o2vHVBEe/I2xUBnE5r2vZewEIqdfGQvZ43a/pQfxgStVs0+JfZMYX/CROAAr6qjwNmA6hWOpqgt+qnnEZMBdT0EhvwSZvIPPB1nYmETznh0LKNpzznlZCSCjMS3bnYACqANKeBjTUiVSA== 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)(54906003)(2906002)(71200400001)(38100700002)(508600001)(110136005)(38070700005)(83380400001)(7696005)(4326008)(66446008)(55016003)(5660300002)(64756008)(6506007)(316002)(8676002)(26005)(8936002)(33656002)(66946007)(66556008)(66476007)(9686003)(52536014)(76116006)(86362001)(44832011)(186003); DIR:OUT; SFP:1101; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?KTSjom1Gjvr9CR6M78IPLWRzP0SS1PPfdqcEsNZmmtuxQOmyy+0e99K/4EHz?= =?us-ascii?Q?QHoYbrXz43wYQlkCsQ8pdaaBq3BE1jf3SB4VcqaLra+6D76pq/LhQcCEUShI?= =?us-ascii?Q?38BXBuASGNcJCg1py5W4k8TRjUDWq/ZNZaztmb1zZLyAyok4So2ZzHkEIRYy?= =?us-ascii?Q?1puSQ4hEVoqCXkn2RcpxSf6s5/yu0lLT4fl1aWYUFqQSqdoQtkh3garL/ZjF?= =?us-ascii?Q?B7YNyRcEEaHtirS8dqeOFiVva73PW1qAIfkSaM7jd/G2EHHV2UbK6DIjy8HZ?= =?us-ascii?Q?SNJu/YNZHhJvHiX08nrRqCm34ynn4ga8ENV06V2u7Wp5JLDEyhdJPhQsDAC4?= =?us-ascii?Q?dh28/sXOArlcsnEK57X63uF+AmCWSwbhIYmAr52OYTzHP37HFL+IlJFW1+lR?= =?us-ascii?Q?iFGexslf948ZY0wWWKzpMIk/Mu6sMW1cqCLF4DrIyHsVyQuI+Huy9gfYOKqW?= =?us-ascii?Q?3nXPqjGdwELSGEeA/3Eb4FlVSbjbhf0UA0dr7AqydnHSlwc8sMCKllWKYkSb?= =?us-ascii?Q?uUKdKYdHbr0WuWTmXF+Xz+Vqn+68wJ/H94yq0qPFUkC/BBRhzmi1uiihqEYQ?= =?us-ascii?Q?j6z6TNEB7necUcGkJvBvPUY5HruQRrIgGVYvgbDLCshO2KovmUD3Y/qMHUtI?= =?us-ascii?Q?hH 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: 6da4fc77-5b17-4c16-a0b6-08da471b5423 X-MS-Exchange-CrossTenant-originalarrivaltime: 05 Jun 2022 17:46:32.7344 (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: X9KSfnBHhkr/WCHf1QqPLtJSaZiK3MlbHDWWfnqSEmPgdGBNl7XjQswm6YUhbw2v9zQ05VNpkmTE8edwtEm9Gg== X-MS-Exchange-Transport-CrossTenantHeadersStamped: BL0PR10MB2836 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.517, 18.0.874 definitions=2022-06-05_09:2022-06-02, 2022-06-05 signatures=0 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 bulkscore=0 malwarescore=0 mlxlogscore=999 adultscore=0 mlxscore=0 phishscore=0 spamscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2204290000 definitions=main-2206050088 X-Proofpoint-ORIG-GUID: LVfBZIPBUAAf-teRxhiIS8G7Cg-Iz36A X-Proofpoint-GUID: LVfBZIPBUAAf-teRxhiIS8G7Cg-Iz36A 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:290740 Archived-At: > why can't you understand that someone thinks > it's a good idea if the package description > is displayed as the author intended? I'd say as the _user_ intends, not the author. Displaying a package description is for the benefit of the user, not the author. It's about what's most useful for users. Best is this, I think: 1. Require a plain-text README, as a minimum. 2. Allow other formats, with appropriate file extensions (e.g. .md, .org). I see no reason for any limit on the kinds of format, for #2. There should be, and likely are, simple ways to generate a plain-text README from this or that more structured format. Condition #1 shouldn't be an obstacle to anyone, I'd think. > I've just tried org-exporting the vertico README.org to a plain-text > UTF-8 version and have to confess, the result is really, really > intriguing. So, yes, such a conversion is at least much better as the > status quo where the org syntax is displayed literally without > highlighting. (I almost don't perceive the org/markdown syntax when > there's syntax highlighting but if there isn't, it looks annoying.) For Org, at least, that seems to confirm my guess that such conversion's already available. > One problem with the "conversion on installation" > approach you suggest is that this would load org, > too, so the arguments against using/loading > org for display would also apply here. Why shouldn't a plain-text README be required at the outset, as part of every package? (Another possibility, if a plain-text README that's equivalent to a structured readme isn't provided, is to allow a plain-text README that tells you how to convert the structured readme to a plain-text version. But I don't see why plain text shouldn't just be a requirement.)