ELPA Howto

ELPA Howto

[Jambunathan K]

I managed to create an elpa compatible tar for orgmode. Recording here
what I did in the hope that it will be useful.

Creating ELPA-compatible tar:

1. Add the enclosed changes to Makefile.
2. Create an ELPA-compatible tarfile with 
   $ make TAG=20100930 elpa
3. Copy the generated org-20100930.tar to the package server

ELPA Server-side setup:

1. Server is running on loopback IP.

,----[ C-h v package-archives RET ]
| package-archives is a variable defined in `package.el'.
| Its value is 
| (("self" . "http://127.0.0.1/packages/"))
| 
`----

2. Directory structure

,----
| > dir packages
|             97 archive-contents
|      3,778,560 org-20100930.tar
|                2 File(s)      3,778,657 bytes
| 
| > cat packages/archive-contents 
|
| (1
|  (org .
|       [(20100930)
|        nil "Outline-based notes management and organizer" tar])
|  )
| 
`----


3. .emacs

,---- 
| (custom-set-variables
|  '(package-archives (quote (("self" . "http://127.0.0.1/packages/")))))
`----

,---- [ .emacs ]
| (when (load (expand-file-name "~/elisp/package.el"))
|   (package-initialize))
`----

The tar file is now ready for installation with M-x list-packages etc
etc.

An Observation:

package.el generates an 'org-autoloads.el' as part of compilation and
loads the same as part of activation. This means that autoloads such as
'org-agenda' gets served from the newly installed package while
non-autoloads like 'org-overview' still point to the old installation.

This means that a restart of Emacs is necessary for the new changes to
take effect. I am not sure whether it is intended. But this behaviour
could surprise the user.

Jambunathan K.

Attachments:

X diff --git a/Makefile b/Makefile
X old mode 100644
X new mode 100755
X index 1c1f317..a84b62f
X --- a/Makefile
X +++ b/Makefile
X @@ -53,6 +53,9 @@ CP = cp -p
X  # Name of the program to install info files
X  INSTALL_INFO=install-info
X  
X +
X +DOCSTRING = "Outline-based notes management and organizer"
X +
X  ##----------------------------------------------------------------------
X  ##  BELOW THIS LINE ON YOUR OWN RISK!
X  ##----------------------------------------------------------------------
X @@ -325,6 +328,14 @@ distfile:
X  	zip -r org-$(TAG).zip org-$(TAG)
X  	gtar zcvf org-$(TAG).tar.gz org-$(TAG)
X  
X +elpa: 	install-info
X +	$(MKDIR) org-$(TAG)
X +	cp -r $(LISPFILES0) org-$(TAG)/
X +	cp $(infodir)/dir org-$(TAG)
X +	cp $(INFOFILES) org-$(TAG)
X +	echo "(define-package \"org\" \"$(TAG)\" \"$(DOCSTRING)\")" > org-$(TAG)/org-pkg.el
X +	tar cf org-$(TAG).tar org-$(TAG) --remove-files
X +	
X  makerelease:
X  	@if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
X  	${MAKE} distfile
X 

Jambunathan K.

Re: ELPA Howto

[Jeff Horn]

> This means that a restart of Emacs is necessary for the new changes to
> take effect. I am not sure whether it is intended. But this behaviour
> could surprise the user.

When using ELPA, I always restart emacs. I got into that habit when
installing many code packages (like the ruby/rails package, is it
Rinari?). I kept getting weird errors without a restart.

I guess what I'm saying is org won't be alone in requiring a restart.

Jeff

Re: ELPA Howto

[Eric Schulte]

Jambunathan K <kjambunathan@gmail.com> writes:

> I managed to create an elpa compatible tar for orgmode. Recording here
> what I did in the hope that it will be useful.
>
> Creating ELPA-compatible tar:
>
> 1. Add the enclosed changes to Makefile.
> 2. Create an ELPA-compatible tarfile with 
>    $ make TAG=20100930 elpa
> 3. Copy the generated org-20100930.tar to the package server
>

That's great,

and it looks like your Makefile patch even automates the process.  I'd
vote that this to be included into the core and that we begin supporting
an elpa-installable version of org-mode tracking the latest named
release.  If possible I think it'd be great to add a git post-commit
hook which could maintain a second elpa org-mode package tracking the
latest git HEAD, although I'm not sure if this is possible and it may
place overmuch burden on the repo.or.cz and the elpa servers.

>
> ELPA Server-side setup:
>

I think we can ignore the server-side setup, since that should be
handled by the elpa server at tromney or gnu.org.  Is this correct?

[...]

> An Observation:
>
> package.el generates an 'org-autoloads.el' as part of compilation and
> loads the same as part of activation. This means that autoloads such as
> 'org-agenda' gets served from the newly installed package while
> non-autoloads like 'org-overview' still point to the old installation.
>
> This means that a restart of Emacs is necessary for the new changes to
> take effect. I am not sure whether it is intended. But this behaviour
> could surprise the user.
>

Noted, perhaps the user could somehow be instructed to run org-reload as
part of the ELPA update process, although I believe even org-reload
leaves some items un-re-initialized.

Cheers -- Eric

>
> Jambunathan K.
>
> Attachments:
>
> X diff --git a/Makefile b/Makefile
> X old mode 100644
> X new mode 100755
> X index 1c1f317..a84b62f
> X --- a/Makefile
> X +++ b/Makefile
> X @@ -53,6 +53,9 @@ CP = cp -p
> X  # Name of the program to install info files
> X  INSTALL_INFO=install-info
> X  
> X +
> X +DOCSTRING = "Outline-based notes management and organizer"
> X +
> X  ##----------------------------------------------------------------------
> X  ##  BELOW THIS LINE ON YOUR OWN RISK!
> X  ##----------------------------------------------------------------------
> X @@ -325,6 +328,14 @@ distfile:
> X  	zip -r org-$(TAG).zip org-$(TAG)
> X  	gtar zcvf org-$(TAG).tar.gz org-$(TAG)
> X  
> X +elpa: 	install-info
> X +	$(MKDIR) org-$(TAG)
> X +	cp -r $(LISPFILES0) org-$(TAG)/
> X +	cp $(infodir)/dir org-$(TAG)
> X +	cp $(INFOFILES) org-$(TAG)
> X +	echo "(define-package \"org\" \"$(TAG)\" \"$(DOCSTRING)\")" > org-$(TAG)/org-pkg.el
> X +	tar cf org-$(TAG).tar org-$(TAG) --remove-files
> X +	
> X  makerelease:
> X  	@if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
> X  	${MAKE} distfile
> X 
>
> Jambunathan K.
>

Re: ELPA Howto

[Jambunathan K]

Hello Eric

"Eric Schulte" <schulte.eric@gmail.com> writes:
> Jambunathan K <kjambunathan@gmail.com> writes:
>
>> I managed to create an elpa compatible tar for orgmode. Recording here
>> what I did in the hope that it will be useful.
>>
>> Creating ELPA-compatible tar:
>>
>> 1. Add the enclosed changes to Makefile.
>> 2. Create an ELPA-compatible tarfile with 
>>    $ make TAG=20100930 elpa
>> 3. Copy the generated org-20100930.tar to the package server
>>
>
> That's great,
>
> and it looks like your Makefile patch even automates the process.  I'd
> vote that this to be included into the core and that we begin supporting
> an elpa-installable version of org-mode tracking the latest named
> release.  If possible I think it'd be great to add a git post-commit
> hook which could maintain a second elpa org-mode package tracking the
> latest git HEAD, although I'm not sure if this is possible and it may
> place overmuch burden on the repo.or.cz and the elpa servers.
>

One could host N latest snapshots and expunge the rest. The snapshots
could be published either daily or weekly etc etc. This could be hooked
to existing cron job.

Just publishing the snapshot itself would help problems surface
faster. The submitter of the problem could temporarily revert to an
earlier stable snapshot and wait till the next snapshot arrives (hoping
that his problem is addressed).

If a snapshot is 'truly' unstable maintainers could intervene and hand
publish the archive.

>>
>> ELPA Server-side setup:
>>
>
> I think we can ignore the server-side setup, since that should be
> handled by the elpa server at tromney or gnu.org.  Is this correct?
>
> [...]
>

One could host packages on http://orgmode.org, In that case my notes
will serve as a good starting point.

Btw hosting the packages (also) on orgmode would give better control and
distribution.

>> An Observation:
>>
>> package.el generates an 'org-autoloads.el' as part of compilation and
>> loads the same as part of activation. This means that autoloads such as
>> 'org-agenda' gets served from the newly installed package while
>> non-autoloads like 'org-overview' still point to the old installation.
>>
>> This means that a restart of Emacs is necessary for the new changes to
>> take effect. I am not sure whether it is intended. But this behaviour
>> could surprise the user.
>>
>
> Noted, perhaps the user could somehow be instructed to run org-reload as
> part of the ELPA update process, although I believe even org-reload
> leaves some items un-re-initialized.
>
> Cheers -- Eric
>
>>
>> Jambunathan K.
>>
>> Attachments:
>>
>> X diff --git a/Makefile b/Makefile
>> X old mode 100644
>> X new mode 100755
>> X index 1c1f317..a84b62f
>> X --- a/Makefile
>> X +++ b/Makefile
>> X @@ -53,6 +53,9 @@ CP = cp -p
>> X  # Name of the program to install info files
>> X  INSTALL_INFO=install-info
>> X  
>> X +
>> X +DOCSTRING = "Outline-based notes management and organizer"
>> X +
>> X  ##----------------------------------------------------------------------
>> X  ##  BELOW THIS LINE ON YOUR OWN RISK!
>> X  ##----------------------------------------------------------------------
>> X @@ -325,6 +328,14 @@ distfile:
>> X  	zip -r org-$(TAG).zip org-$(TAG)
>> X  	gtar zcvf org-$(TAG).tar.gz org-$(TAG)
>> X  
>> X +elpa: 	install-info
>> X +	$(MKDIR) org-$(TAG)
>> X +	cp -r $(LISPFILES0) org-$(TAG)/
>> X +	cp $(infodir)/dir org-$(TAG)
>> X +	cp $(INFOFILES) org-$(TAG)
>> X +	echo "(define-package \"org\" \"$(TAG)\" \"$(DOCSTRING)\")" > org-$(TAG)/org-pkg.el
>> X +	tar cf org-$(TAG).tar org-$(TAG) --remove-files
>> X +	
>> X  makerelease:
>> X  	@if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
>> X  	${MAKE} distfile
>> X 
>>
>> Jambunathan K.
>>

Re: ELPA Howto

[Eric Schulte]

Hi Jambunathan,

Jambunathan K <kjambunathan@gmail.com> writes:

> Hello Eric
>
> "Eric Schulte" <schulte.eric@gmail.com> writes:
>> Jambunathan K <kjambunathan@gmail.com> writes:
>>
[...]
>>>
>>> ELPA Server-side setup:
>>>
>>
>> I think we can ignore the server-side setup, since that should be
>> handled by the elpa server at tromney or gnu.org.  Is this correct?
>>
>> [...]
>>
>
> One could host packages on http://orgmode.org, In that case my notes
> will serve as a good starting point.
>
> Btw hosting the packages (also) on orgmode would give better control and
> distribution.
>

Oh, that's a great point.  How would the maintainers of orgmode.org feel
about using it to host packages through ELPA?

-- Eric

Re: ELPA Howto

[Eric Schulte]

Hi Jambunathan,

Would you mind re-sending your original Makefile patch un-commented so
that it will be captured by the patchwork system, and dropped into the
org-mode development review process?

Thanks -- Eric

"Eric Schulte" <schulte.eric@gmail.com> writes:

> Hi Jambunathan,
>
> Jambunathan K <kjambunathan@gmail.com> writes:
>
>> Hello Eric
>>
>> "Eric Schulte" <schulte.eric@gmail.com> writes:
>>> Jambunathan K <kjambunathan@gmail.com> writes:
>>>
> [...]
>>>>
>>>> ELPA Server-side setup:
>>>>
>>>
>>> I think we can ignore the server-side setup, since that should be
>>> handled by the elpa server at tromney or gnu.org.  Is this correct?
>>>
>>> [...]
>>>
>>
>> One could host packages on http://orgmode.org, In that case my notes
>> will serve as a good starting point.
>>
>> Btw hosting the packages (also) on orgmode would give better control and
>> distribution.
>>
>
> Oh, that's a great point.  How would the maintainers of orgmode.org feel
> about using it to host packages through ELPA?
>
> -- Eric

Re: ELPA Howto

[Carsten Dominik]

Ji Jambunathan,

there is something in your Makefile patch I do not understand:

>
> X @@ -325,6 +328,14 @@ distfile:
> X  	zip -r org-$(TAG).zip org-$(TAG)
> X  	gtar zcvf org-$(TAG).tar.gz org-$(TAG)
> X
> X +elpa: 	install-info

Why are you saying the elpa is dependent on install-info?

- Carsten


> X +	$(MKDIR) org-$(TAG)
> X +	cp -r $(LISPFILES0) org-$(TAG)/
> X +	cp $(infodir)/dir org-$(TAG)
> X +	cp $(INFOFILES) org-$(TAG)
> X +	echo "(define-package \"org\" \"$(TAG)\" \"$(DOCSTRING)\")" >  
> org-$(TAG)/org-pkg.el
> X +	tar cf org-$(TAG).tar org-$(TAG) --remove-files
> X +	
> X  makerelease:
> X  	@if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
> X  	${MAKE} distfile
> X
>
> Jambunathan K.
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

- Carsten

Re: ELPA Howto

[Jambunathan K]

[-- Attachment #1: Type: text/plain, Size: 1000 bytes --]


Hello Carsten

> Ji Jambunathan,
>
> there is something in your Makefile patch I do not understand:
>
>>
>> X @@ -325,6 +328,14 @@ distfile:
>> X  	zip -r org-$(TAG).zip org-$(TAG)
>> X  	gtar zcvf org-$(TAG).tar.gz org-$(TAG)
>> X
>> X +elpa: 	install-info
>
> Why are you saying the elpa is dependent on install-info?
>

So that the 'dir' file is created and info manual is made available to
the user. 

,---- [ from package.texi ]
|   If the package has an Info manual, you should distribute the needed
| info files, plus a @file{dir} file made with @command{install-info}.
| @xref{Invoking install-info, Invoking install-info, Invoking
| install-info, texinfo, Texinfo}.
`----

,---- [ from package.el ]
|     ;; Add info node.
|     (when (file-exists-p (expand-file-name "dir" pkg-dir))
|       ;; FIXME: not the friendliest, but simple.
|       (require 'info)
|       (info-initialize)
|       (push pkg-dir Info-directory-list))
`----

I am re-attaching my original patch.

Jambunathan K.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: patch --]
[-- Type: text/x-patch, Size: 1297 bytes --]

From 0abd4b5e7fdf740b8b749a57f93da4f59f010606 Mon Sep 17 00:00:00 2001
From: Jambunathan K <kjambunathan@gmail.com>
Date: Thu, 30 Sep 2010 12:10:29 +0530
Subject: [PATCH 2] Add support for elpa archives

---
 Makefile |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)
 mode change 100644 => 100755 Makefile

diff --git a/Makefile b/Makefile
old mode 100644
new mode 100755
index 1c1f317..a84b62f
--- a/Makefile
+++ b/Makefile
@@ -53,6 +53,9 @@ CP = cp -p
 # Name of the program to install info files
 INSTALL_INFO=install-info
 
+
+DOCSTRING = "Outline-based notes management and organizer"
+
 ##----------------------------------------------------------------------
 ##  BELOW THIS LINE ON YOUR OWN RISK!
 ##----------------------------------------------------------------------
@@ -325,6 +328,14 @@ distfile:
 	zip -r org-$(TAG).zip org-$(TAG)
 	gtar zcvf org-$(TAG).tar.gz org-$(TAG)
 
+elpa: 	install-info
+	$(MKDIR) org-$(TAG)
+	cp -r $(LISPFILES0) org-$(TAG)/
+	cp $(infodir)/dir org-$(TAG)
+	cp $(INFOFILES) org-$(TAG)
+	echo "(define-package \"org\" \"$(TAG)\" \"$(DOCSTRING)\")" > org-$(TAG)/org-pkg.el
+	tar cf org-$(TAG).tar org-$(TAG) --remove-files
+	
 makerelease:
 	@if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
 	${MAKE} distfile
-- 
1.7.2.3


[-- Attachment #3: Type: text/plain, Size: 683 bytes --]


> - Carsten
>
>
>> X +	$(MKDIR) org-$(TAG)
>> X +	cp -r $(LISPFILES0) org-$(TAG)/
>> X +	cp $(infodir)/dir org-$(TAG)
>> X +	cp $(INFOFILES) org-$(TAG)
>> X +	echo "(define-package \"org\" \"$(TAG)\" \"$(DOCSTRING)\")" >
>> org-$(TAG)/org-pkg.el
>> X +	tar cf org-$(TAG).tar org-$(TAG) --remove-files
>> X +	
>> X  makerelease:
>> X  	@if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
>> X  	${MAKE} distfile
>> X
>>
>> Jambunathan K.
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten

[-- Attachment #4: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: ELPA Howto

[Jambunathan K]

Carsten Dominik <carsten.dominik@gmail.com> writes:

> Ji Jambunathan,
>
> there is something in your Makefile patch I do not understand:
>
>>
>> X @@ -325,6 +328,14 @@ distfile:
>> X  	zip -r org-$(TAG).zip org-$(TAG)
>> X  	gtar zcvf org-$(TAG).tar.gz org-$(TAG)
>> X
>> X +elpa: 	install-info
>
> Why are you saying the elpa is dependent on install-info?
>

It's not dependent on 'install-info' (as a make target) but requires
that install-info be run.

I was plain lazy to copy the needed lines :-). 

Jambunathan K.


> - Carsten
>
>
>> X +	$(MKDIR) org-$(TAG)
>> X +	cp -r $(LISPFILES0) org-$(TAG)/
>> X +	cp $(infodir)/dir org-$(TAG)
>> X +	cp $(INFOFILES) org-$(TAG)
>> X +	echo "(define-package \"org\" \"$(TAG)\" \"$(DOCSTRING)\")" >
>> org-$(TAG)/org-pkg.el
>> X +	tar cf org-$(TAG).tar org-$(TAG) --remove-files
>> X +	
>> X  makerelease:
>> X  	@if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
>> X  	${MAKE} distfile
>> X
>>
>> Jambunathan K.
>>
>> _______________________________________________
>> Emacs-orgmode mailing list
>> Please use `Reply All' to send replies to the list.
>> Emacs-orgmode@gnu.org
>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>
> - Carsten

Re: ELPA Howto

[Carsten Dominik]

On Oct 4, 2010, at 8:23 PM, Jambunathan K wrote:

> Carsten Dominik <carsten.dominik@gmail.com> writes:
>
>> Ji Jambunathan,
>>
>> there is something in your Makefile patch I do not understand:
>>
>>>
>>> X @@ -325,6 +328,14 @@ distfile:
>>> X  	zip -r org-$(TAG).zip org-$(TAG)
>>> X  	gtar zcvf org-$(TAG).tar.gz org-$(TAG)
>>> X
>>> X +elpa: 	install-info
>>
>> Why are you saying the elpa is dependent on install-info?
>>
>
> It's not dependent on 'install-info' (as a make target) but requires
> that install-info be run.

I simple do not understand.  I believe install-info is used
to add lines to the main dir file for info somewhere on the system.
I think (but I am not sure) the package only needs to contain the
doc/dir file that is present in the org git repo.  There is no need
to create this file.

What am I missing?

- Carsten

>
> I was plain lazy to copy the needed lines :-).
>
> Jambunathan K.
>
>
>> - Carsten
>>
>>
>>> X +	$(MKDIR) org-$(TAG)
>>> X +	cp -r $(LISPFILES0) org-$(TAG)/
>>> X +	cp $(infodir)/dir org-$(TAG)
>>> X +	cp $(INFOFILES) org-$(TAG)
>>> X +	echo "(define-package \"org\" \"$(TAG)\" \"$(DOCSTRING)\")" >
>>> org-$(TAG)/org-pkg.el
>>> X +	tar cf org-$(TAG).tar org-$(TAG) --remove-files
>>> X +	
>>> X  makerelease:
>>> X  	@if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
>>> X  	${MAKE} distfile
>>> X
>>>
>>> Jambunathan K.
>>>
>>> _______________________________________________
>>> Emacs-orgmode mailing list
>>> Please use `Reply All' to send replies to the list.
>>> Emacs-orgmode@gnu.org
>>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>>
>> - Carsten

Re: ELPA Howto

[Jambunathan K]

[-- Attachment #1: Type: text/plain, Size: 99 bytes --]


Carsten 

Reworked the changes based on your feedback. Customize to your tastes.

Jambunathan K.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Support-for-elpa-compatible-tarballs.patch --]
[-- Type: text/x-patch, Size: 1695 bytes --]

From 1121461037e0308054afeabf8c67bd1a568dd9b1 Mon Sep 17 00:00:00 2001
From: Jambunathan K <kjambunathan@gmail.com>
Date: Tue, 5 Oct 2010 15:33:08 +0530
Subject: [PATCH] Support for elpa-compatible tarballs

* Makefile (pkg): New target for creating elpa-compatible tarball.
---
 Makefile |   24 ++++++++++++++++++++++++
 1 files changed, 24 insertions(+), 0 deletions(-)

diff --git a/Makefile b/Makefile
index 1c1f317..3b92534 100644
--- a/Makefile
+++ b/Makefile
@@ -164,6 +164,19 @@ CARDFILES   = doc/orgcard.tex doc/orgcard.pdf doc/orgcard_letter.pdf
 TEXIFILES   = doc/org.texi
 INFOFILES   = doc/org
 
+# Package Manager (ELPA)
+PKG_TAG = $(shell date +%Y%m%d)
+PKG_DOC = "Outline-based notes management and organizer"
+PKG_REQ = "nil"
+
+PKG_FILES = $(LISPFILES0)		\
+            doc/dir doc/org		\
+            doc/pdflayout.sty		\
+            doc/org.pdf			\
+            doc/orgguide.pdf		\
+            doc/orgcard.tex		\
+            doc/orgcard.pdf		\
+            doc/orgcard_letter.pdf
 
 .SUFFIXES: .el .elc .texi
 SHELL = /bin/sh
@@ -325,6 +338,17 @@ distfile:
 	zip -r org-$(TAG).zip org-$(TAG)
 	gtar zcvf org-$(TAG).tar.gz org-$(TAG)
 
+pkg:
+	@if [ "X$(PKG_TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
+	touch doc/org.texi doc/orgcard.tex # force update
+	${MAKE} info
+	${MAKE} doc
+	rm -rf org-$(PKG_TAG) org-$(PKG_TAG).tar
+	$(MKDIR) org-$(PKG_TAG)
+	cp -r $(PKG_FILES) org-$(PKG_TAG)
+	echo "(define-package \"org\" \"$(PKG_TAG)\" \"$(PKG_DOC)\" $(PKG_REQ))" > org-$(PKG_TAG)/org-pkg.el
+	tar cf org-$(PKG_TAG).tar org-$(PKG_TAG) --remove-files
+
 makerelease:
 	@if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
 	${MAKE} distfile
-- 
1.7.2.3


[-- Attachment #3: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Version string (was Re: ELPA Howto)

[Jambunathan K]

In the context of ELPA packages, I think there might be a need to
revisit how orgmode's version string is defined.

For example, 7.01h wouldn't be successfully parsed by (version-to-list
...) which the package manager uses internally.

So 7.01h could be mapped to 7.0.1.8 or 7.1.8.

,----[ C-h f version-to-list RET ]
| version-to-list is a compiled Lisp function in `subr.el'.
| 
| (version-to-list VER)
| 
| Convert version string VER into an integer list.
| 
| The version syntax is given by the following EBNF:
| 
|    VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
| 
|    NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
| 
|    SEPARATOR ::= `version-separator' (which see)
| 	       | `version-regexp-alist' (which see).
| 
| The NUMBER part is optional if SEPARATOR is a match for an element
| in `version-regexp-alist'.
| 
| As an example of valid version syntax:
| 
|    1.0pre2   1.0.7.5   22.8beta3   0.9alpha1   6.9.30Beta
| 
| As an example of invalid version syntax:
| 
|    1.0prepre2   1.0..7.5   22.8X3   alpha3.2   .5
| 
| As an example of version convertion:
| 
|    String Version    Integer List Version
|    "1.0.7.5"         (1  0  7 5)
|    "1.0pre2"         (1  0 -1 2)
|    "1.0PRE2"         (1  0 -1 2)
|    "22.8beta3"       (22 8 -2 3)
|    "22.8Beta3"       (22 8 -2 3)
|    "0.9alpha1"       (0  9 -3 1)
|    "0.9AlphA1"       (0  9 -3 1)
|    "0.9alpha"        (0  9 -3)
| 
| See documentation for `version-separator' and `version-regexp-alist'.
| 
| [back]
`----

Jambunathan K.

Re: Version string (was Re: ELPA Howto)

[Carsten Dominik]

On Oct 5, 2010, at 1:09 PM, Jambunathan K wrote:

>
> In the context of ELPA packages, I think there might be a need to
> revisit how orgmode's version string is defined.
>
> For example, 7.01h wouldn't be successfully parsed by (version-to-list
> ...) which the package manager uses internally.
>
> So 7.01h could be mapped to 7.0.1.8 or 7.1.8.


Hi Jambunthan,

in what places would the version string have to be modified?
Do I need to change the org.el variable org-version, or the string in  
the VERSION keyword in file headers, or where?

- Carsten

>
> ,----[ C-h f version-to-list RET ]
> | version-to-list is a compiled Lisp function in `subr.el'.
> |
> | (version-to-list VER)
> |
> | Convert version string VER into an integer list.
> |
> | The version syntax is given by the following EBNF:
> |
> |    VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
> |
> |    NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
> |
> |    SEPARATOR ::= `version-separator' (which see)
> | 	       | `version-regexp-alist' (which see).
> |
> | The NUMBER part is optional if SEPARATOR is a match for an element
> | in `version-regexp-alist'.
> |
> | As an example of valid version syntax:
> |
> |    1.0pre2   1.0.7.5   22.8beta3   0.9alpha1   6.9.30Beta
> |
> | As an example of invalid version syntax:
> |
> |    1.0prepre2   1.0..7.5   22.8X3   alpha3.2   .5
> |
> | As an example of version convertion:
> |
> |    String Version    Integer List Version
> |    "1.0.7.5"         (1  0  7 5)
> |    "1.0pre2"         (1  0 -1 2)
> |    "1.0PRE2"         (1  0 -1 2)
> |    "22.8beta3"       (22 8 -2 3)
> |    "22.8Beta3"       (22 8 -2 3)
> |    "0.9alpha1"       (0  9 -3 1)
> |    "0.9AlphA1"       (0  9 -3 1)
> |    "0.9alpha"        (0  9 -3)
> |
> | See documentation for `version-separator' and `version-regexp- 
> alist'.
> |
> | [back]
> `----
>
> Jambunathan K.

- Carsten

Re: Version string (was Re: ELPA Howto)

[Carsten Dominik]

Hi,

so how do we move forward with generating packages?  I have installed  
the code by Jambunthan in the Make file, but I guess we still need to  
negotiate with the EPLA on how to upload and update the package, about  
name conventions etc.

Is there anyone whole is willing to sort this all out and then show us  
the simple upload recipe?

My feeling is that the latest release should be on the package  
server.  daily bleeding edge builds could be there as well, under a  
different name.

Thanks

- Carsten


On Oct 8, 2010, at 12:38 PM, Carsten Dominik wrote:

>
> On Oct 5, 2010, at 1:09 PM, Jambunathan K wrote:
>
>>
>> In the context of ELPA packages, I think there might be a need to
>> revisit how orgmode's version string is defined.
>>
>> For example, 7.01h wouldn't be successfully parsed by (version-to- 
>> list
>> ...) which the package manager uses internally.
>>
>> So 7.01h could be mapped to 7.0.1.8 or 7.1.8.
>
>
> Hi Jambunthan,
>
> in what places would the version string have to be modified?
> Do I need to change the org.el variable org-version, or the string  
> in the VERSION keyword in file headers, or where?
>
> - Carsten
>
>>
>> ,----[ C-h f version-to-list RET ]
>> | version-to-list is a compiled Lisp function in `subr.el'.
>> |
>> | (version-to-list VER)
>> |
>> | Convert version string VER into an integer list.
>> |
>> | The version syntax is given by the following EBNF:
>> |
>> |    VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
>> |
>> |    NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
>> |
>> |    SEPARATOR ::= `version-separator' (which see)
>> | 	       | `version-regexp-alist' (which see).
>> |
>> | The NUMBER part is optional if SEPARATOR is a match for an element
>> | in `version-regexp-alist'.
>> |
>> | As an example of valid version syntax:
>> |
>> |    1.0pre2   1.0.7.5   22.8beta3   0.9alpha1   6.9.30Beta
>> |
>> | As an example of invalid version syntax:
>> |
>> |    1.0prepre2   1.0..7.5   22.8X3   alpha3.2   .5
>> |
>> | As an example of version convertion:
>> |
>> |    String Version    Integer List Version
>> |    "1.0.7.5"         (1  0  7 5)
>> |    "1.0pre2"         (1  0 -1 2)
>> |    "1.0PRE2"         (1  0 -1 2)
>> |    "22.8beta3"       (22 8 -2 3)
>> |    "22.8Beta3"       (22 8 -2 3)
>> |    "0.9alpha1"       (0  9 -3 1)
>> |    "0.9AlphA1"       (0  9 -3 1)
>> |    "0.9alpha"        (0  9 -3)
>> |
>> | See documentation for `version-separator' and `version-regexp- 
>> alist'.
>> |
>> | [back]
>> `----
>>
>> Jambunathan K.
>
> - Carsten
>
>
>

- Carsten

Re: Version string (was Re: ELPA Howto)

[Jambunathan K]

(Resent to mailing-list)

Carsten Dominik <carsten.dominik@gmail.com> writes:

> On Oct 5, 2010, at 1:09 PM, Jambunathan K wrote:
>
>>
>> In the context of ELPA packages, I think there might be a need to
>> revisit how orgmode's version string is defined.
>>
>> For example, 7.01h wouldn't be successfully parsed by (version-to-list
>> ...) which the package manager uses internally.
>>
>> So 7.01h could be mapped to 7.0.1.8 or 7.1.8.
>
>
> Hi Jambunthan,
>
> in what places would the version string have to be modified?
> Do I need to change the org.el variable org-version, or the string in
> the VERSION keyword in file headers, or where?
>

From a functional perspective, there is *no need* to modify any of the
el files. One has to just take care that PKG_TAG is a
'version-to-list'-compatible string. The tarball thus generated will be
very much usable.

From a maintenance perspective you might want to move away from 7.01h
convention and adopt a convention that is dictated by elpa. 

Jambunathan K.

> - Carsten
>
>>
>> ,----[ C-h f version-to-list RET ]
>> | version-to-list is a compiled Lisp function in `subr.el'.
>> |
>> | (version-to-list VER)
>> |
>> | Convert version string VER into an integer list.
>> |
>> | The version syntax is given by the following EBNF:
>> |
>> |    VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
>> |
>> |    NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
>> |
>> |    SEPARATOR ::= `version-separator' (which see)
>> | 	       | `version-regexp-alist' (which see).
>> |
>> | The NUMBER part is optional if SEPARATOR is a match for an element
>> | in `version-regexp-alist'.
>> |
>> | As an example of valid version syntax:
>> |
>> |    1.0pre2   1.0.7.5   22.8beta3   0.9alpha1   6.9.30Beta
>> |
>> | As an example of invalid version syntax:
>> |
>> |    1.0prepre2   1.0..7.5   22.8X3   alpha3.2   .5
>> |
>> | As an example of version convertion:
>> |
>> |    String Version    Integer List Version
>> |    "1.0.7.5"         (1  0  7 5)
>> |    "1.0pre2"         (1  0 -1 2)
>> |    "1.0PRE2"         (1  0 -1 2)
>> |    "22.8beta3"       (22 8 -2 3)
>> |    "22.8Beta3"       (22 8 -2 3)
>> |    "0.9alpha1"       (0  9 -3 1)
>> |    "0.9AlphA1"       (0  9 -3 1)
>> |    "0.9alpha"        (0  9 -3)
>> |
>> | See documentation for `version-separator' and `version-regexp-
>> alist'.
>> |
>> | [back]
>> `----
>>
>> Jambunathan K.
>
> - Carsten

Re: Version string (was Re: ELPA Howto)

[Jambunathan K]

Attaching the response from Chong Yidong to my queries. Read down
below.

Jambunathan K.


Carsten Dominik <carsten.dominik@gmail.com> writes:

> Hi,
>
> so how do we move forward with generating packages?  I have installed
> the code by Jambunthan in the Make file, but I guess we still need to
> negotiate with the EPLA on how to upload and update the package, about
> name conventions etc.
>
> Is there anyone whole is willing to sort this all out and then show us
> the simple upload recipe?
>
> My feeling is that the latest release should be on the package server.
> daily bleeding edge builds could be there as well, under a  different
> name.
>

/* Begin Attachment */

From: Chong Yidong <cyd@stupidchicken.com>
Subject: Re: Packages + elpa.gnu.org
To: Jambunathan K <kjambunathan@gmail.com>
Cc: emacs-devel@gnu.org
Date: Fri, 08 Oct 2010 23:55:52 -0400
Message-ID: <87y6a86muv.fsf@stupidchicken.com>

Jambunathan K <kjambunathan@gmail.com> writes:

> 1. Who acts as a janitor for the elpa repository.

Me.  Ted Zlatanov also has access.  We've both been pretty busy on other
parts of Emacs lately, though, so there are a couple of packages that
are in the pipeline for uploading (including AuCTEX).

> 2. How does one upload packages - a mail drop to the maintainer, remote
>    update from within emacs - scp, ftp etc etc . (Is package-x.el's
>    package-upload-buffer and related configuration documented
>    somewhere.)

Probably the easiest way to set this up is for someone on the org-mode
team to upload the dailies to a server somewhere on the web, giving the
tarball a deterministic name.  Then, someone (probably me) will have to
set up a cron job on elpa.gnu.org to check for that tarball each day,
download it, and run `package-upload-file' to add it to the repository.

> 3. Does the package manager expect that builtin packages be versioned in
>    a special way. For example, can the stable release be called 7.0.1
>    while a daily snapshot be called 20101008?

The package manager uses the most recent version of a package, as
defined by `version-list-<'.

> 4. Any general guidelines on what packages would be accepted there and
>    how often an update can happen. Are daily snapshots allowed.

The main requirement is for package copyrights to be FSF assigned.  I
think providing dailies is fine.

/* End Attachment */


> Thanks
>
> - Carsten
>
>
> On Oct 8, 2010, at 12:38 PM, Carsten Dominik wrote:
>
>>
>> On Oct 5, 2010, at 1:09 PM, Jambunathan K wrote:
>>
>>>
>>> In the context of ELPA packages, I think there might be a need to
>>> revisit how orgmode's version string is defined.
>>>
>>> For example, 7.01h wouldn't be successfully parsed by (version-to-
>>> list
>>> ...) which the package manager uses internally.
>>>
>>> So 7.01h could be mapped to 7.0.1.8 or 7.1.8.
>>
>>
>> Hi Jambunthan,
>>
>> in what places would the version string have to be modified?
>> Do I need to change the org.el variable org-version, or the string
>> in the VERSION keyword in file headers, or where?
>>
>> - Carsten
>>
>>>
>>> ,----[ C-h f version-to-list RET ]
>>> | version-to-list is a compiled Lisp function in `subr.el'.
>>> |
>>> | (version-to-list VER)
>>> |
>>> | Convert version string VER into an integer list.
>>> |
>>> | The version syntax is given by the following EBNF:
>>> |
>>> |    VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
>>> |
>>> |    NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
>>> |
>>> |    SEPARATOR ::= `version-separator' (which see)
>>> | 	       | `version-regexp-alist' (which see).
>>> |
>>> | The NUMBER part is optional if SEPARATOR is a match for an element
>>> | in `version-regexp-alist'.
>>> |
>>> | As an example of valid version syntax:
>>> |
>>> |    1.0pre2   1.0.7.5   22.8beta3   0.9alpha1   6.9.30Beta
>>> |
>>> | As an example of invalid version syntax:
>>> |
>>> |    1.0prepre2   1.0..7.5   22.8X3   alpha3.2   .5
>>> |
>>> | As an example of version convertion:
>>> |
>>> |    String Version    Integer List Version
>>> |    "1.0.7.5"         (1  0  7 5)
>>> |    "1.0pre2"         (1  0 -1 2)
>>> |    "1.0PRE2"         (1  0 -1 2)
>>> |    "22.8beta3"       (22 8 -2 3)
>>> |    "22.8Beta3"       (22 8 -2 3)
>>> |    "0.9alpha1"       (0  9 -3 1)
>>> |    "0.9AlphA1"       (0  9 -3 1)
>>> |    "0.9alpha"        (0  9 -3)
>>> |
>>> | See documentation for `version-separator' and `version-regexp-
>>> alist'.
>>> |
>>> | [back]
>>> `----
>>>
>>> Jambunathan K.
>>
>> - Carsten
>>
>>
>>
>
> - Carsten

Re: ELPA Howto

[Bastien]

Hi Jambunathan,

thanks for your work on the ELPA-compatible Makefile.

Jambunathan K <kjambunathan@gmail.com> writes:

> One could host N latest snapshots and expunge the rest. The snapshots
> could be published either daily or weekly etc etc. This could be hooked
> to existing cron job.

This is now the case - see this directory:

  http://orgmode.org/pkg/daily/

> Just publishing the snapshot itself would help problems surface
> faster.

I hope so!

-- 
 Bastien

Re: ELPA Howto

[Jambunathan K]

[-- Attachment #1: Type: text/plain, Size: 1201 bytes --]


Wonderful Bastien. 

Part-1
======

Did you forget to upload http://orgmode.org/pkg/daily/archive-contents?
Once this is done orgmode.org could be used as an ELPA repo in and of
itself. I am attaching a sample archive-contents for your ready
reference.

Part-2
======

Downloaded and installed org-20101020.tar. The installation process
reported some compile time warnings. See down below. 

Part-3
======

There is an interactive defun package-upload-file in package-x.el that
can automate the creation of a new entry in archive-contents.

Rough instructions are

1. Hand fix package-upload-buffer-internal
   - point archive-url to our own repo.
   - comment out the call to package--update-news

2. (setq package-archive-upload-base "~/pkg/daily/")
3. (package-upload-file "/tmp/org-20101016.tar")
   
Step-3 will 
1. Download existing archive-contents
1. copy /tmp/org-20101016.tar to ~/pkg/daily/
3. Update archive-contents with the new entry.

If this is all too hairy may be one can just write a emacs batch script
that adds/removes entries from archive-contents taking care to use
(version-to-list ...) for recording the package version.

Jambunathan K.  

Attachments:

1. archive-contents


[-- Attachment #2: archive-contents --]
[-- Type: text/plain, Size: 453 bytes --]

(1
 (org .
      [(20101016)
       nil "Outline-based notes management and organizer" tar])
 (org .
      [(20101017)
       nil "Outline-based notes management and organizer" tar])
 (org .
      [(20101018)
       nil "Outline-based notes management and organizer" tar])
 (org .
      [(20101019)
       nil "Outline-based notes management and organizer" tar])
 (org .
      [(20101020)
       nil "Outline-based notes management and organizer" tar]))

[-- Attachment #3: Type: text/plain, Size: 54 bytes --]



2. Compiler Warnings reported by org-20101016.tar:


[-- Attachment #4: compiler-warnings.txt --]
[-- Type: text/plain, Size: 1711 bytes --]

Compiling file c:/Documents and Settings/kjambunathan/My Documents/My Data/.emacs.d/elpa/org-20101020/ob-R.el at Thu Oct 21 00:49:34 2010

In end of data:
ob-R.el:306:1:Warning: the function `org-number-sequence' is not known to be
    defined.
Compiling file c:/Documents and Settings/kjambunathan/My Documents/My Data/.emacs.d/elpa/org-20101020/ob.el at Thu Oct 21 00:49:42 2010

In end of data:
ob.el:1828:1:Warning: the function `org-number-sequence' is not known to be
    defined.

Compiling file c:/Documents and Settings/kjambunathan/My Documents/My Data/.emacs.d/elpa/org-20101020/org-agenda.el at Thu Oct 21 00:49:44 2010

In org-agenda-goto-date:
org-agenda.el:5827:35:Warning: reference to free variable
    `org-agenda-jump-prefer-future'

Compiling file c:/Documents and Settings/kjambunathan/My Documents/My Data/.emacs.d/elpa/org-20101020/org-compat.el at Thu Oct 21 00:49:55 2010

In org-find-library-name:
org-compat.el:329:14:Warning: find-library called with 3 arguments, but
    accepts only 1

In org-select-frame-set-input-focus:
org-compat.el:364:18:Warning: `w32-focus-frame' is an obsolete function (as of
    Emacs 23.1); use `x-focus-frame' instead.

Compiling file c:/Documents and Settings/kjambunathan/My Documents/My Data/.emacs.d/elpa/org-20101020/org.el at Thu Oct 21 00:50:19 2010

In org-toggle-pretty-entities:
org.el:5539:4:Warning: attempt to inline `org-decompose-region' before it was
    defined

In org-unfontify-region:
org.el:5639:48:Warning: attempt to inline `org-decompose-region' before it was
    defined

In end of data:
org.el:19680:1:Warning: the function `org-decompose-region' is not known to be
    defined.

Compiling no file at Thu Oct 21 00:51:49 2010

[-- Attachment #5: Type: text/plain, Size: 529 bytes --]



Bastien <bastien.guerry@wikimedia.fr> writes:

> Hi Jambunathan,
>
> thanks for your work on the ELPA-compatible Makefile.
>
> Jambunathan K <kjambunathan@gmail.com> writes:
>
>> One could host N latest snapshots and expunge the rest. The snapshots
>> could be published either daily or weekly etc etc. This could be hooked
>> to existing cron job.
>
> This is now the case - see this directory:
>
>   http://orgmode.org/pkg/daily/
>
>> Just publishing the snapshot itself would help problems surface
>> faster.
>
> I hope so!

[-- Attachment #6: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: ELPA Howto

[Eric Schulte]

Hi,

Jambunathan K <kjambunathan@gmail.com> writes:

[...]
>
> Part-2
> ======
>
> Downloaded and installed org-20101020.tar. The installation process
> reported some compile time warnings. See down below. 
>

I've fixed two of the babel related compile time warnings.  I think that
in general releases will be warning free, but the dailies will be full
of compile-time warnings.  Hopefully these warnings don't pose any real
problem for ELPA.