From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#65027: 30.0.50; [PATCH] Document .elpaignore behavior in the Emacs Lisp manual Date: Wed, 10 Jan 2024 13:49:57 -0800 Message-ID: References: <761581a0-fa77-e89c-01e8-d0baeae838f5@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="33169"; mail-complaints-to="usenet@ciao.gmane.io" Cc: philipk@posteo.net, corwin@bru.st, monnier@iro.umontreal.ca, info@protesilaos.com, 65027@debbugs.gnu.org To: Jim Porter Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Jan 10 22:51:24 2024 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 1rNgTs-0008PD-0W for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 10 Jan 2024 22:51:24 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rNgTZ-0002Ov-PA; Wed, 10 Jan 2024 16:51:05 -0500 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 1rNgTY-0002Ol-IA for bug-gnu-emacs@gnu.org; Wed, 10 Jan 2024 16:51:04 -0500 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 1rNgTY-0004tq-2m for bug-gnu-emacs@gnu.org; Wed, 10 Jan 2024 16:51:04 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rNgTW-0001Sx-0D for bug-gnu-emacs@gnu.org; Wed, 10 Jan 2024 16:51:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 10 Jan 2024 21:51: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.17049234065545 (code B ref 65027); Wed, 10 Jan 2024 21:51:01 +0000 Original-Received: (at 65027) by debbugs.gnu.org; 10 Jan 2024 21:50:06 +0000 Original-Received: from localhost ([127.0.0.1]:43362 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rNgSb-0001RN-T1 for submit@debbugs.gnu.org; Wed, 10 Jan 2024 16:50:06 -0500 Original-Received: from mail-lj1-x236.google.com ([2a00:1450:4864:20::236]:52392) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rNgSY-0001Ql-UV for 65027@debbugs.gnu.org; Wed, 10 Jan 2024 16:50:03 -0500 Original-Received: by mail-lj1-x236.google.com with SMTP id 38308e7fff4ca-2cd33336b32so62188861fa.0 for <65027@debbugs.gnu.org>; Wed, 10 Jan 2024 13:50:03 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1704923398; x=1705528198; darn=debbugs.gnu.org; h=cc:to:subject:message-id:date:mime-version:references:in-reply-to :from:from:to:cc:subject:date:message-id:reply-to; bh=iVUqzwSUYSLvf8H4m6opYAj4bYkWawSxVpA3l3r4Fgg=; b=VF10f+tDZdxGCIH88trYY4xcuiywp4OkX+vDNJn+q1HPTTU/NiLwqjF23C7dn6sTj5 YLWsBxnWNiD5vy6ARNzMTm2RKrQFHh8lCga+sIEt1le8Hf7O/oPwxfnEIjbv2s67Ebfn b592xLmHwRy0aXJeFntm0X0yEEiavZYYK/8Xk+hBSP7yWcltCSZI1BToOThBvAVC8FJe ePalk2rnAaEuZ1gCnoZxSARbQHJqBvw1XwkW7yoDYeajUnKMZFFSb3wAEd5U/lhxTP2s kHo5VBUUxZaEkMxzInRqdxYZjNKxX9FhC05k033rlsQ2uezGLpPblpIUDB1P2i5BvaBa ZTaw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1704923398; x=1705528198; h=cc:to:subject:message-id:date:mime-version:references:in-reply-to :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=iVUqzwSUYSLvf8H4m6opYAj4bYkWawSxVpA3l3r4Fgg=; b=RA0YiURj4jHm+/+OI22DeiRbkbgSx2B/p7Foefq3V+tiDZwgJUkll5VD/ojuI3nljZ OW/nJSb51Iyl1jy/4Q1oocNjdBCasmNN4OGJH54z7y6Ua49xjPnCCWTKG7l+Z3+7rQ1T 37YJ488p6GD0Q9hlaoV72MOkfT6M1iPifQg3X6D4A3wlSYcNGteVozB0lBddJnaaAGIg ZFHm27ksMm1Y3tIru+F9AjYpT9TUaYAzcBcCDBYzAd7nBrAdiNJF63HQiglSLtYbuRXY 1gz+pJZG/EehqGjut/xDcMptomf7UaBsI9BmxhEZEckzNKZ/Pvmub1CpT6h6sgVBESGR cg4g== X-Gm-Message-State: AOJu0YzZKEKAa4TltJIYL4UaVH7gWJrlVgmYRjAeq3HPKdyVdrNGr5er sxhgCPs8y91guYZfclQVpR7EtO+2ui/Ohnrx2Lt6jdq6YoYJyA== X-Google-Smtp-Source: AGHT+IES5YbT2Tow0RafFfCOINEoUDy+bxR5FXpNJogE54N58Dwifqzh4bqmV0fSNAFVpyfE7vtKYe4PkcZfS/URYbk= X-Received: by 2002:a2e:9e4e:0:b0:2cc:88ad:dd6b with SMTP id g14-20020a2e9e4e000000b002cc88addd6bmr97025ljk.76.1704923397794; Wed, 10 Jan 2024 13:49:57 -0800 (PST) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Wed, 10 Jan 2024 13:49:57 -0800 In-Reply-To: <761581a0-fa77-e89c-01e8-d0baeae838f5@gmail.com> (Jim Porter's message of "Wed, 2 Aug 2023 21:56:38 -0700") 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:277828 Archived-At: Jim Porter writes: > X-Debbugs-Cc: philipk@posteo.net > > 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.) Here's a small patch to document this in > the Package section of the Emacs Lisp manual. > > This is just a first pass at documenting this feature, so I'm happy to add > further details if anyone thinks it's warranted. There was talk in this bug report about writing a new "package manual", and Protesilaos volunteered to write a first draft. But while we wait for that work to complete, is there any reason not to install the below patch? Because we currently don't have any documentation for .elpaignore, and it's kind of frustrating to have to tell people that it exists over and over. Thoughts/objections? Thanks in advance. > From a5dc5f63003aea4bda4f382ec46c0556edb14f1a Mon Sep 17 00:00:00 2001 > From: Jim Porter > Date: Wed, 2 Aug 2023 21:51:18 -0700 > Subject: [PATCH] * doc/lispref/package.texi (Multi-file Packages): Document > ".elpaignore". > > --- > doc/lispref/package.texi | 7 +++++++ > 1 file changed, 7 insertions(+) > > diff --git a/doc/lispref/package.texi b/doc/lispref/package.texi > index 2952e7dfcfc..ce29b4be72a 100644 > --- a/doc/lispref/package.texi > +++ b/doc/lispref/package.texi > @@ -284,6 +284,13 @@ Multi-file Packages > (expand-file-name file superfrobnicator-base)) > @end smallexample > > + If your project contains files that you don't wish to distribute to > +users (e.g.@: regression tests), you can add them to an > +@file{.elpaignore} file. In this file, each line lists a file or > +wildcard matching files to ignore when producing your package's tar > +file on ELPA. (ELPA will pass this file to @command{tar} with the > +@code{-X} option.) > + > @node Package Archives > @section Creating and Maintaining Package Archives > @cindex package archive