Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove outdated editors/emacs/lambdapi-mode-pkg.el #1170

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tarsius
Copy link

@tarsius tarsius commented Dec 30, 2024

The information in <name>-pkg.el did not agree with the information in <name>.el. This pull-requests addresses that be removing the outdated <name>-pkg.el.

While the end-user package manager package.el expects a file <name>-pkg.el, this should only be generate by the package archive (such as GNU ELPA and MELPA), instead of being tracked in the upstream repository.

The tools used maintain the various *ELPA, do not use <name>-pkg.el as a data source, they only generate it.

  • elpa-admin.el, the tool used for GNU ELPA and NonGNU ELPA, does not use <name>-pkg.el as a data source and it never has.

  • package-build.el, the tool used for Melpa, prefers <name>.el but currently falls back to get information missing from there from <name>-pkg.el instead. I am goint to change that; soon <name>-pkg.el will be ignored as a data source by this tool too.

@fblanqui
Copy link
Member

Thank you very much @tarsius for your PR. We're going to look after this as soon as possible.

@tarsius
Copy link
Author

tarsius commented Jan 10, 2025

Thanks!

@Alidra
Copy link
Member

Alidra commented Jan 13, 2025

Thank you @tarsius for the PR.
If I understand it right, you suggest to remove <name>-pkg.el because in our particular case it does not hold any information that is not already in the <name>.el file and in all cases, the use of <name>-pkg.el is deprecated and will be ignored in the future.

Is that right?

However, I have the following error when trying to install the package locally (with "M-x package-install-file ) :
Wrong type argument: arrayp, nil

Please note, it works when I install from a tar file that contains the <name>-pkg.el file.

@Alidra
Copy link
Member

Alidra commented Jan 13, 2025

Also, please update the editors/emacs/Makefile by removing line 16: SRC += lambdapi-mode-pkg.el

@tarsius
Copy link
Author

tarsius commented Jan 13, 2025

Is that right?

Yes, except ...

install the package locally (with "M-x package-install-file )

... this is the one use case that does require <name>-pkg.el.

I don't think many people do that, but since you do, I recommend you keep lambdapi-mode-pkg.el and instead duplicate the information in lambdapi-mode.el's header, while making sure that you never forget to update the information in both places. (Since you are used to editing the lambdapi-mode-pkg.el file, you are unlikely to forget about that, so I recommend adding a ;; Do not forget to also update headers in lambdapi-mode.el! comment to that file.)

@Alidra
Copy link
Member

Alidra commented Jan 15, 2025

Thanks again @tarsius,

Indeed, we use this method to test the plugin locally before releasing it. If you know any better way to do so, please let us know.
Also, we will keep the <name>-pkg.el file and make sure it is sync with <name>.el for now. In the future, we will generate it locally the first from for testing purposes.

@tarsius
Copy link
Author

tarsius commented Jan 16, 2025

If you know any better way to do so, please let us know.

Unfortunately I have not prepared any easy to use steps for that. Also see okamsn/loopy#224 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants