From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Akib Azmain Turja Newsgroups: gmane.emacs.devel Subject: Re: Convert README.org to plain text README while installing package Date: Sat, 04 Jun 2022 23:32:31 +0600 Message-ID: <87v8tg5o7k.fsf@disroot.org> References: <87leuca7v7.fsf@disroot.org> <87czfopmsd.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="23913"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Alan Mackenzie , Tassilo Horn Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Jun 04 19:34:10 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 1nxXf8-0005yI-1b for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Jun 2022 19:34:10 +0200 Original-Received: from localhost ([::1]:39756 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nxXf6-0001W1-Io for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Jun 2022 13:34:08 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:43402) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxXdj-0000no-SF for emacs-devel@gnu.org; Sat, 04 Jun 2022 13:32:43 -0400 Original-Received: from knopi.disroot.org ([178.21.23.139]:48470) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxXdh-0003Fe-Uv; Sat, 04 Jun 2022 13:32:43 -0400 Original-Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id 94AE1438FE; Sat, 4 Jun 2022 19:32:39 +0200 (CEST) X-Virus-Scanned: SPAM Filter at disroot.org Original-Received: from knopi.disroot.org ([127.0.0.1]) by localhost (disroot.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id vcMest628yJf; Sat, 4 Jun 2022 19:32:38 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1654363957; bh=SZ+HFNDgs/mEa17tSo8jS7vhDqp3mwNGqAqofGVMQ88=; h=From:To:Cc:Subject:In-Reply-To:References:Date; b=WHgJXmuDiPSeW69EPJR9jyFwne3rd0zPpTMzC5EOCqi3xZyX8F0QGQ6a1XGjBcZuP LXZckJXlLg1BWUJwX8inPNafqTUGpnN1GsA6eANkPpYvoHZMIAvAHShvG15JN/kehN oWBHkAV/4/MdsHaC5f8ZKVwGa98oUvIfkKW1WJOFX/dp8iaxv0tWtPAczuP2uJYbUe PJu5FQARZp0R2X2A4ohxPwV3xogBrtesnyf8yj5xnYrHhZMR+X8zNcdxhG5wb8g/54 ZIpAT9GW1SOvSf3KVhWo2DWnYTAzH8ruKub3lAsnkeM17c1hh4FL65ZffFzDlxZOv1 WaQ9THdyeOhCQ== In-Reply-To: Received-SPF: pass client-ip=178.21.23.139; envelope-from=akib@disroot.org; helo=knopi.disroot.org X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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, 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:290672 Archived-At: --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Alan Mackenzie writes: > Hello, Tassilo. > > On Sat, Jun 04, 2022 at 15:32:10 +0200, Tassilo Horn wrote: >> Akib Azmain Turja writes: > >> Hi Akib, > >> > Packages on ELPA or NonGNU ELPA with README.org show pretty >> > description both with describe-package and web browser. But after >> > installing a package, describe-package shows the Org source code, >> > which contains many useless things (I mean useless for showing in the >> > *Help* buffer). > >> > Isn't it possible to convert README.org to plain text README while >> > compiling the package, possibly optionally? Changing package--compile >> > function should do the job. > >> An alternative would be to enable (parts of) org-mode in the *Help* >> buffer. I've just tried `M-x describe-package RET corfu RET` which >> comes with a README.org and then enabling org-mode in the *Help* buffer. >> That looked really nice and didn't seem to cause bad effects except that >> the [back] / [forward] buttons stopped working. > > No, no, no, no! Org mode is a highly complicated, obscure mode which is > NOT part of core Emacs, and mustn't become so. What you're proposing is > a slippery slope, where ever greater portions of org mode would get > pushed into the core, causing ever greater problems for those who do not > use org mode. > > You pointed out one such problem yourself, org mode key bindings will > take up key binding space currently used by other modes and by users. Yeah, I don't also use Org mode very often, so enabling Org mode will be an even bigger problem to me. > > Surely the solution has got to be to encourage package authors to write > plain text (or .texi) documentation, by pointing out the difficulties > the non-standard .org format creates. Writing docs in Texinfo is obviously good, but I think its too much work for small packages. > >> Bye, >> Tassilo > > --=20 > Alan Mackenzie (Nuremberg, Germany). =2D-=20 Akib Azmain Turja This message is signed by me with my GnuPG key. It's fingerprint is: 7001 8CE5 819F 17A3 BBA6 66AF E74F 0EFA 922A E7F5 --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEEyVTKmrtL6kNBe3FRVTX89U2IYWsFAmKbly8ACgkQVTX89U2I YWv6Pg//QwdpcWKeH7YHq3O8TVe8j1gV7jNBaS//WB3roZ5Y0klP/GAwSJFTVssr 8KicQWi5hmYHv1MEUMzo8c4iiMvnUvpAASwXBDmWItzkSKU3r8IcCdqcPmRVobgX jqfTCCIOn4RkTc5qi3ZigIk42zTWg1AtTMZF+xVJrIIIYYTuR6nd+PJey9jaUaLl gJYxPAAx31NuohvJ7FVQja1EuzwEXW/I2CNeQHODsvcxjMWkYGzx6rltJAid7PxR 9TrDC/5CciuWbMi3BkJcgsxvBWUrMqKcp0j3Emx/LLPIL6apNY6W1s2DWHe82h0b ZP6ev+OYWttTwcOl6Uz/HO4z9jGVvcRKSgDqLgTcfIWtt6JTZpLW/2JOHZuWIsGL lf2Wt/pzmZ4b5euFfvoDfXltWLNzccZnm0WZ1O7M0G/6VGIo2G4h6Gz+XT7MwZ3J gSrSmH6vhMeCv/MlKGT6LfiNBToZLeLQqF5odX8rlArXSK7rmP111KOu/HkMjn7m jdHHNh1eI57proPLuaazhv2qU8zJgI/D5MBm4WwkgZEl2PY5zd5qa52AWllY0+7L OoXT1cVJGgf4Ja/aHNN+f7hhbh2yJHVU7/rM83n5ze3llTX8CdyXnF2mXijuWdXN XUxjP9q3ow3rE4WU9dVpe1eUe5kilR/DPPOVrbD2UhTdfTkyvLQ= =orK/ -----END PGP SIGNATURE----- --=-=-=--