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

package-vc-install fails to install manual #182

Closed
josephmturner opened this issue Apr 18, 2023 · 10 comments
Closed

package-vc-install fails to install manual #182

josephmturner opened this issue Apr 18, 2023 · 10 comments

Comments

@josephmturner
Copy link
Contributor

josephmturner commented Apr 18, 2023

To reproduce:
On Emacs 29+, run

(package-vc-install "https://github.com/nobiot/org-transclusion")

This successfully installs org-transclusion, but it does not install the manual.

I think that package-vc--build-documentation expects the docs to be at docs/org-transclusion.org but instead they are located at docs/org-transclusion-manual.org.

Perhaps there is a way to tell package-vc where the docs are actually located?

@josephmturner josephmturner changed the title package-vc-install fails with package-vc-install fails due to missing docs file Apr 18, 2023
@josephmturner
Copy link
Contributor Author

I attempted to solve this issue by renaming org-transclusion-manual.org to org-transclusion.org, but it didn't work. More details in this commit message.

@nobiot
Copy link
Owner

nobiot commented Apr 21, 2023

Thanks. I'd like to take a deeper look, but:

  1. Emacs 29 has not been officially released.
  2. This package is shared via ELPA, thus it is considered part of Emacs -- and it can build the manual via make

For these two reasons, I am wondering if this issue should not be addressed via package-vc rather than via individual packages.

In general, I have no problem adapting a way that would work for both package-vc and ELPA. At this stage, I would like to wait for Emacs 29 to be officially released.

In addition... I have no idea what change is required to support the current state of package-vc. Do you have suggestions? I don't understand why the build process cannot find fdl.texi. It's in the same directory as org-transclusion-manual.org and #+texinfo: @include fdl.texi should be syntactically correct...

@josephmturner josephmturner changed the title package-vc-install fails due to missing docs file package-vc-install fails to install manual Apr 22, 2023
@josephmturner
Copy link
Contributor Author

With emacs -Q, (package-vc-install "https://github.com/nobiot/org-transclusion") does not fail. However, the manual does not build. I have sent an email to the help-gnu-emacs mailing list, and I'll report back here with what I learn!

@nobiot
Copy link
Owner

nobiot commented Apr 22, 2023

Thank you for asking in he mailing list. Quite excited about what we might discover.

@nobiot
Copy link
Owner

nobiot commented Apr 22, 2023

Just as additional information...
This is something I set it once and have forgotten since. But ELPA is configured this way as below. This means:

  1. make org-transclusion.org is used, which should generate org-transclusion.org from docs/org-transclusion-manual.org
  2. I believe the resultant org-transclusion.org is stored in default-directory of the file, which should be docs directory. Thusdocs/org-transclusion.org gets generated
  3. ELPA then takes docs/org-transclusion.org as the source to generate the Info doc

https://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/elpa-packages#n491

 (org-transclusion	:url "https://github.com/nobiot/org-transclusion"
  :make "org-transclusion.org"
  :doc "docs/org-transclusion.org"
  :readme "README.org")

@josephmturner
Copy link
Contributor Author

Thank you, @nobiot! The issue is that package-vc doesn't currently support the :make package specification key.

@josephmturner
Copy link
Contributor Author

I have submitted a patch to add support for :make and :shell-command spec args in package-vc.

And also a separate patch for the issue where the build process could not find fdl.texi.

@nobiot
Copy link
Owner

nobiot commented May 8, 2023

Great. Anything I should do on my end?

@josephmturner
Copy link
Contributor Author

josephmturner commented May 8, 2023

Nope! The second patch is slated for Emacs 29, but the first is not, so it'll be a while before most users will be able to install the org-transclusion manual with package-vc.

package-vc can still install org-transclusion just fine though!

EDIT: typo

@nobiot
Copy link
Owner

nobiot commented May 9, 2023

Okay, thank you!

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

No branches or pull requests

2 participants