From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.bugs Subject: bug#65027: 30.0.50; [PATCH] Document .elpaignore behavior in the Emacs Lisp manual Date: Thu, 03 Aug 2023 19:09:41 +0000 Message-ID: <87r0okq6x6.fsf@posteo.net> References: <761581a0-fa77-e89c-01e8-d0baeae838f5@gmail.com> <83cz04xzvk.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="33302"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Eli Zaretskii , Stefan Monnier , 65027@debbugs.gnu.org To: Jim Porter Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Aug 03 21:10:28 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1qRdiO-0008Tn-5P for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 03 Aug 2023 21:10:28 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qRdi2-0001ES-H3; Thu, 03 Aug 2023 15:10:06 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qRdi0-0001EB-Fy for bug-gnu-emacs@gnu.org; Thu, 03 Aug 2023 15:10:04 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qRdhy-0000TS-8Q for bug-gnu-emacs@gnu.org; Thu, 03 Aug 2023 15:10:04 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qRdhx-0006bB-R4 for bug-gnu-emacs@gnu.org; Thu, 03 Aug 2023 15:10:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Philip Kaludercic Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 03 Aug 2023 19:10:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65027 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 65027-submit@debbugs.gnu.org id=B65027.169108979125341 (code B ref 65027); Thu, 03 Aug 2023 19:10:01 +0000 Original-Received: (at 65027) by debbugs.gnu.org; 3 Aug 2023 19:09:51 +0000 Original-Received: from localhost ([127.0.0.1]:52954 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qRdhm-0006af-Q8 for submit@debbugs.gnu.org; Thu, 03 Aug 2023 15:09:51 -0400 Original-Received: from mout02.posteo.de ([185.67.36.66]:52677) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qRdhl-0006aS-9L for 65027@debbugs.gnu.org; Thu, 03 Aug 2023 15:09:49 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id B919F240104 for <65027@debbugs.gnu.org>; Thu, 3 Aug 2023 21:09:43 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1691089783; bh=JDuujOziQsxxGnwVLuGcOraeEepAJhPI19i3arv6K98=; h=From:To:Cc:Subject:Autocrypt:Date:Message-ID:MIME-Version:From; b=fV2ul0e2pMVL0Evxg+Ru2tlUFNizOXQNzxtacI6+YDjN2uep7Tj+0WRt1iDo0XIfA fkGsVumWGArbsN4Fj2OqPhu4GJ5AVNnTe0f3L33U+NeE1daR5OKFLu1j3I60P5TcL7 1qYxvGigX5IqjneJAkL12i2jYTIm3F+jDEZdqEvMUPBuufwXoPvmhqKICDcIADCcYa Ln4XWccV36zZqeVYahK2GfpD/HjjLTl9p1QArZt59SOkGkfyOvhnpq05qfijSfKLBX uRsZvxxMnT1Kx+Z+aHIFde/aq/Kehp0Ac4eGAXt94wPx7AIuw40WHy7tk4IIJ26qzH OChf3sqycYdWA== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4RGz1L5qYjz6txy; Thu, 3 Aug 2023 21:09:42 +0200 (CEST) In-Reply-To: (Jim Porter's message of "Thu, 3 Aug 2023 10:24:58 -0700") Autocrypt: addr=philipk@posteo.net; keydata= mDMEZBBQQhYJKwYBBAHaRw8BAQdAHJuofBrfqFh12uQu0Yi7mrl525F28eTmwUDflFNmdui0QlBo aWxpcCBLYWx1ZGVyY2ljIChnZW5lcmF0ZWQgYnkgYXV0b2NyeXB0LmVsKSA8cGhpbGlwa0Bwb3N0 ZW8ubmV0PoiWBBMWCAA+FiEEDg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwMFCQHhM4AFCwkI BwIGFQoJCAsCBBYCAwECHgECF4AACgkQ8xYDWXahwulikAEA77hloUiSrXgFkUVJhlKBpLCHUjA0 mWZ9j9w5d08+jVwBAK6c4iGP7j+/PhbkxaEKa4V3MzIl7zJkcNNjHCXmvFcEuDgEZBBQQhIKKwYB BAGXVQEFAQEHQI5NLiLRjZy3OfSt1dhCmFyn+fN/QKELUYQetiaoe+MMAwEIB4h+BBgWCAAmFiEE Dg7HY17ghYlni8XN8xYDWXahwukFAmQQUEICGwwFCQHhM4AACgkQ8xYDWXahwukm+wEA8cml4JpK NeAu65rg+auKrPOP6TP/4YWRCTIvuYDm0joBALw98AMz7/qMHvSCeU/hw9PL6u6R2EScxtpKnWof z4oM X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:266620 Archived-At: Jim Porter writes: > On 8/3/2023 6:36 AM, Stefan Monnier via Bug reports for GNU Emacs, the > Swiss army knife of text editors wrote: >>>> From the discussion in bug#64985, Eli mentioned that .elpaignore wasn't >>>> documented. (It turns out it's mentioned briefly in the GNU ELPA README, >>>> but that's the only place I could find.) >> That's because it was the only place where `.elpaignore` was >> used/obeyed >> (until the introduction of `package-vc`). > > Yeah, something more general that I've noticed is that as a package > author, the documentation for how to make a package for GNU ELPA is > split between the GNU ELPA README and the Emacs Lisp manual. I found > this a bit confusing when I prepared my first package for submission > to GNU ELPA, so (for example) I didn't learn about ".elpaignore" until > after I sent my package submission to emacs-devel. > > Maybe it would make sense to put all the documentation in the Emacs > Lisp manual, and then the GNU ELPA README can be the home for > documentation about how to work with the GNU ELPA repository > specifically (mainly as an administrator). What do you think? When I find some time, I plan to write and add a package to ELPA that could help automatise some of the necessary steps for contributing to ELPA (explaining the difference between GNU and NonGNU, signing the CA, testing for common mistakes, clean byte-compiling, etc.). It would be possible to also suggest creating a .elpaignore file as well. Of course, this does not mean there shouldn't be any guidelines written down in the manual.