emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Morgan Willcock <morgan@ice9.digital>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: Lin Jian <me@linj.tech>,   emacs-orgmode@gnu.org
Subject: Re: [BUG] What about excluding .dir-locals.el from GNU ELPA tarball?
Date: Sun, 15 Sep 2024 17:58:31 +0100	[thread overview]
Message-ID: <87tteg26rs.fsf@ice9.digital> (raw)
In-Reply-To: <87bk0p72bi.fsf@localhost> (Ihor Radchenko's message of "Sun, 15 Sep 2024 08:23:29 +0000")

Ihor Radchenko <yantar92@posteo.net> writes:

> Lin Jian <me@linj.tech> writes:
>
>> Currently, the .dir-locals.el file is included in the GNU ELPA
>> tarball[1], which causes this compilation error[2] when doing AOT native
>> compilation for Emacs lisp packages in NixOS.
>
> I do not see why anything is wrong on Org side.
> .dir-locals.el is a perfectly valid file that may be created by users as
> well. The fact that they are native-compiled is probably a bug in NixOS
> or a missing feature in Emacs's native compilation (maybe it should skip
> compiling dir locals automatically).

I believe it is up to the file to opt-out of compilation.

If the file is created with add-dir-local-variable there is a boiler
plate header inserted which opts out:

  ;;; Directory Local Variables            -*- no-byte-compile: t -*-
  ;;; For more information see (info "(emacs) Directory Variables")

>> We can workaround this by skipping native compilation for
>> .dir-locals.el.  However, I do not think .dir-locals.el has to be
>> included in the GNU ELPA tarball.  In addition, MELPA ignores[3] that
>> file by default.
>>
>> Could you exclude .dir-locals.el from GNU ELPA tarball?  FYI,
>> :ignored-files[4] of GNU ELPA specification can be used to do this.
>
> Having dir locals file in the tarball can be useful for the users who
> wish to edit Org mode's source code. We set a number of editing defaults
> there that are employed across Org codebase. These defaults make our
> life easier when users create patches by directly modifying Org mode code
> they got via ELPA.
>
> Not a bug.
> Canceled.
>
> I suggest you to report a bug or feature request to Emacs upstream about
> native compiling .dir-locals.el.

I don't think there is any upstream bug.  The solution would be to add
the missing header to the .dir-locals.el file.

-- 
Morgan Willcock


  reply	other threads:[~2024-09-15 16:59 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-12 23:07 [BUG] What about excluding .dir-locals.el from GNU ELPA tarball? Lin Jian
2024-09-15  8:23 ` Ihor Radchenko
2024-09-15 16:58   ` Morgan Willcock [this message]
2024-09-16 19:22     ` Ihor Radchenko
2024-09-17 18:13       ` Morgan Willcock
2024-09-16  0:58   ` Lin Jian

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87tteg26rs.fsf@ice9.digital \
    --to=morgan@ice9.digital \
    --cc=emacs-orgmode@gnu.org \
    --cc=me@linj.tech \
    --cc=yantar92@posteo.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).