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

Implement rebuilding of orgmode docs #568

Closed
aspiers opened this issue Aug 29, 2020 · 4 comments
Closed

Implement rebuilding of orgmode docs #568

aspiers opened this issue Aug 29, 2020 · 4 comments

Comments

@aspiers
Copy link
Contributor

aspiers commented Aug 29, 2020

I just hacked a patch to the org-mode manual (org-manual.org) and initiated a rebuild of the org package, but it didn't rebuild the texinfo file (doc/org.texi). I think this is because straight.el currently has no way of knowing that the .texi file is generated from org-manual.org via an info target in Org's Makefile system. So perhaps addressing #541 might be one way of enabling a fix for this?

@aspiers
Copy link
Contributor Author

aspiers commented Aug 29, 2020

Doh - duplicate of #72. Sorry for the noise!

@aspiers
Copy link
Contributor Author

aspiers commented Oct 24, 2020

Actually, this isn't technically a duplicate since #72 was about a much more general feature.

If I understand this comment in #71 correctly, now that #72 is now implemented supporting arbitrary build commands (yay!), once #115 (el-get recipe support) is resolved by PR #549, straight.el will be able to automatically run Org's Makefiles which build the Org manual by taking advantage of the build step's in el-get's recipe for org-mode.

Is that all correct?

@progfolio
Copy link
Contributor

@aspiers straight implements a psuedo org-elpa recipe repository which (as of #72) provides a recipe similar to el-get's for org/org-plus-contrib. straight-get-recipe should return:

`(org-plus-contrib :type git :repo "https://code.orgmode.org/bzg/org-mode.git"
                   :local-repo "org"
                   :files (:defaults "contrib/lisp/*.el")
                   :build ,(let ((make (if (eq system-type 'berkeley-unix) "gmake" "make"))
                                 (emacs (concat "EMACS=" invocation-directory invocation-name)))
                             `(,make "oldorg" ,emacs)))

Which straight--convert-recipe will convert to the system specific build commands. For example, on my gnu/linux system the recipe is converted to:

(org-plus-contrib :type git :repo "https://code.orgmode.org/bzg/org-mode.git"
                  :local-repo "org"
                  :files (:defaults "contrib/lisp/*.el")
                  :build ("make" "oldorg" "EMACS=/usr/bin/emacs"))

I just made a test edit to doc/org-manaul.org to be sure and everything seemed to work fine. Let me know if that's the case for you or if you run into any problems.

@aspiers
Copy link
Contributor Author

aspiers commented Oct 25, 2020

Ah, thanks - I'd forgotten that the Org recipes were hardcoded in straight.el. Yep, seems to work so I'm closing again - thanks a lot!!

@aspiers aspiers closed this as completed Oct 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

3 participants