unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Philip Kaludercic <philipk@posteo.net>
To: Jonas Bernoulli <jonas@bernoul.li>
Cc: Okamsn <okamsn@protonmail.com>,  emacs-devel@gnu.org
Subject: Re: How to install documentation in sub-directory with Package VC?
Date: Sun, 09 Apr 2023 21:55:15 +0000	[thread overview]
Message-ID: <87r0ssoh4s.fsf@posteo.net> (raw)
In-Reply-To: <87lej0lx1j.fsf@bernoul.li> (Jonas Bernoulli's message of "Sun, 09 Apr 2023 20:39:52 +0200")

Jonas Bernoulli <jonas@bernoul.li> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
>>> We only provide :url, and where appropriate :branch, :vc-backend and
>>> :maintainer.  
>>
>> :maintainer is currently not used
>
> Removed.
>
> Could you please ping me when you add new properties?

I don't see the point of adding support for it to package-vc, that is to
say that I don't know what would want to make use of it.

>> (TBH I am not sure what the point of it is in elpa-admin to begin
>> with),
>
> Sending emails to a package's maintainer.  It is used to send every
> pushed commit for example.

Every commit?  From what it see being done in elpa-admin.el it is
invoked when a package fails to build and on releases (as is the case
when a maintainer is listed in the package header).

>>> We don't set :doc or :lisp-dir (yet?).
>>
>> Do you think it could be possible to support :doc and :lisp-dir.  IIUC
>> the issue is that MELPA only accepts a list of files to include when
>> bundling a package (:files) and the build system would have to infer
>> what what is?
>
> Why is :doc needed?  I think package-install simply runs makeinfo on all
> texi files, but of course it can rely on them being at the top-level.

I don't see that package-install attempts anything like that.

> It might end up trying (and failing) to directly process gpl.texi and
> similar.  But still, cannot package-vc simply do that too?

Sure, that can be done.  There was just no need for that up until now
considering that ELPA added :doc provides the information.

> The value of :doc can also be an org file and we cannot just blindly try
> to transcode *all* org files to texi.  But Melpa doesn't support
> exporting ort to texi, so packages distributed there cannot assume that
> that happens.  (I wish Melpa supported this and I actually implemented
> it, but the main Melpa maintainers didn't want to merge it for security
> reasons.)

Hmm, understandable.  As long as MELPA wouldn't install a manual in
these cases, I think it is tolerable if package-vc doesn't do so either.

> I am not sure determining :lisp-dir from :files on the archive's side,
> is easier and/or more reliable than package-vc doing it itself based
> solely on what it finds in the latest commit.  In Borg I use "if lisp/
> exists, then use that, else use ./" and that works for 99% of all
> packages.

What package-vc does is check both "lisp" and "src" checking if they
contain .el files.  Good to know that this works well enough.

> I think it would be better to first try to add some heuristics to
> package-vc.  If that doesn't work well enough, we can still later
> make package-build generate more elpa-admin-style metadata.

Yeah, it should all work well enough for now, I guess the only way to
improve this is to deal with real-world edge-cases that are discovered
over time.

-- 
Philip Kaludercic



  parent reply	other threads:[~2023-04-09 21:55 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-14  3:13 How to install documentation in sub-directory with Package VC? Okamsn
2023-03-14 15:56 ` Philip Kaludercic
2023-03-15  9:41   ` Philip Kaludercic
2023-03-16  1:37     ` Okamsn
2023-03-16  8:44       ` Philip Kaludercic
2023-03-28  1:50         ` Okamsn
2023-03-28  7:41           ` Philip Kaludercic
2023-04-02  0:41             ` Okamsn
2023-04-02  5:24               ` Eli Zaretskii
2023-04-05  7:30               ` Philip Kaludercic
2023-04-06  3:52                 ` Okamsn
2023-04-06 15:42                   ` Philip Kaludercic
2023-04-10 13:39                     ` Philip Kaludercic
2023-04-12  0:04                       ` Okamsn
2023-04-12  7:27                         ` Philip Kaludercic
2023-04-12  7:41                           ` Eli Zaretskii
2023-04-12  7:48                             ` Philip Kaludercic
2023-04-07 21:46             ` Jonas Bernoulli
2023-04-08  8:36               ` Philip Kaludercic
2023-04-09 18:39                 ` Jonas Bernoulli
2023-04-09 20:44                   ` Lynn Winebarger
2023-04-09 21:55                   ` Philip Kaludercic [this message]
2023-03-28 11:48           ` Eli Zaretskii

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.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=87r0ssoh4s.fsf@posteo.net \
    --to=philipk@posteo.net \
    --cc=emacs-devel@gnu.org \
    --cc=jonas@bernoul.li \
    --cc=okamsn@protonmail.com \
    /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.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).