emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* [PATCH] (ELPA): Support for building Package Variants and Package Upload
@ 2010-11-12 13:14 Jambunathan K
  2010-11-12 15:09 ` Carsten Dominik
  0 siblings, 1 reply; 4+ messages in thread
From: Jambunathan K @ 2010-11-12 13:14 UTC (permalink / raw)
  To: emacs-orgmode; +Cc: bzg

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



1 Summary 
~~~~~~~~~~
  (ELPA): Add support for the following:

  1. Package README files
  2. Upload of Packages to the repository
  3. Building of Package Variants (stable, snapshot ect)

  This patch is backward-compatible and it wouldn't question the
  status-quo. It understands existing scheme of things.

  To exploit this patch, a patched-up package-x.el is highly
  recommended. Read on ...

2 Building Plain Vanilla Packages 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

2.1 Notes 
==========

   Builds plain vanialla packages. Doesn't upload packages. 

   There will be a WARNING message saying that the package was not
   uploaded. This can be noted and ignored.
   

2.2 Build Procedure 
====================
   1. make PKG_TAG=7.3
      This builds org-7.3.tar
   2. make pkg
      This builds org-20101112.tar

3 Building Package Variants 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

3.1 Notes 
==========
    Modify/Uncomment PKG_SEP and PKG_FLAVOUR setting in Makefile as
    desired. 

    There is a choice of PKG_SEP. Pick what you like. Use of '-' is
    discouraged.

    Assumption is:
    - stable releases are built with an explicit PKG_TAG
    - stable releases are non-flavored while the snapshot builds are
      flavored.

3.2 Build Procedure 
====================
   1. make PKG_TAG=7.3
      This builds org-7.3.tar
   2. make pkg
      This builds org@snaphsot-20101112.tar

4 Package Uploads 
~~~~~~~~~~~~~~~~~~

4.1 Notes 
==========
   - PKG_UPLOAD_DIR: directory where the package files are
     uploaded. i.e., it is the *local directory* behind the repo URL
     ([http://orgmode.org/pkg/daily/]). For eg, /var/www/pub/pkg/daily/.

     IMPORTANT NOTE: Remember to include the trailing '/' in the
     directory while setting this variable.

   - PKG_EL_DIR: This is added to the load-path during BATCH
     compilation. The intention is two fold:

     1. load package.el and package-x.el if the build machine is using
        Emacs-23 or less (which don't ship with package manager)

     2. Override package.el and package-x.el that ship with Emacs with
        a custom or a patched up version.

     IMPORTANT NOTE: The rule for 'pkg-upload' depends on my patch to
     Package Manager which is accepted but not committed yet because
     of the (postal?) delay in FSF copyright requirements.

    [http://lists.gnu.org/archive/html/emacs-devel/2010-11/msg00026.html]


4.2 Build Procedure 
====================

   1. make PKG_EL_DIR="~/elisp" PKG_UPLOAD_DIR="~/packages/" PKG_TAG=7.3 pkg

      This builds org-7.3.tar and uploads the same to "~/packages"
      using package-x.el in "~/elisp/"

   2. make PKG_EL_DIR="~/elisp" PKG_UPLOAD_DIR="~/packages/" pkg

      This builds org-20101112.tar and uploads the same to
      "~/packages" using package-x.el in "~/elisp/"

Jambunathan K.

Attachments
~~~~~~~~~~~


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

From 06d227cc4d4e3ac86320690ebbe184bb804d9bf1 Mon Sep 17 00:00:00 2001
From: Jambunathan K <kjambunathan@gmail.com>
Date: Fri, 12 Nov 2010 16:32:51 +0530
Subject: [PATCH] (ELPA): Support for building Package Variants and Package Upload.

(PKG_TAG): Use PKG_TAG to control package flavour. If unspecified,
assume a snapshot build.

(PKG_SEP, PKG_FLAVOUR): New config variables for building various
flavours of ELPA tarball. For eg., org-7.3.tar,
org@snapshot-20101112.tar, org-snapshot-20101112 etc.

(PKG_FILES): Removed
(PKG_BASE_FILES): Files here end up in the root dir.
(PKG_DOC_FILES): Files here end up in the doc dir.

(PKG_README_ORG_FILE): README file

(PKG_EL_DIR): Load path for package.el and package-x.el. Useful if the
build machine runs an 'old' Emacs or if the build process requires a
patched up versions of these files.

(PKG_UPLOAD_DIR): 'pub' dir of the webserver serving the ELPA tarball.

(pkg-upload, pkg-readme): New targets subsumed within pkg target.
---
diff --git a/Makefile b/Makefile
old mode 100644
new mode 100755
index 0b15abe..5c13d8b
--- a/Makefile
+++ b/Makefile
@@ -165,18 +165,44 @@ TEXIFILES   = doc/org.texi
 INFOFILES   = doc/org
 
 # Package Manager (ELPA)
+
+# PKG_TAG = 
+
+ifndef PKG_TAG
+# PKG_SEP = @
+# PKG_SEP = -
+# PKG_SEP = .
+# PKG_FLAVOUR = snapshot
 PKG_TAG = $(shell date +%Y%m%d)
+endif
+
+PKG_BNAME = org
+PKG_QNAME = $(PKG_BNAME)$(PKG_SEP)$(PKG_FLAVOUR)
+PKG_FNAME = $(PKG_QNAME)-$(PKG_TAG)
+
 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
+PKG_BASE_FILES = $(LISPFILES0)          \
+                 doc/dir doc/org        
+
+PKG_DOC_FILES =                         \
+                doc/org.pdf             \
+                doc/org.html            \
+                doc/orgguide.pdf        \
+                doc/orgcard.txt         \
+                doc/orgcard.pdf         \
+                doc/orgcard_letter.pdf
+
+PKG_README_ORG_FILE = ORGWEBPAGE/Changes.org
+PKG_README_TXT_FILE = $(PKG_README_ORG_FILE:%.org=%.txt)
+
+# PKG_EL_DIR = 
+# PKG_UPLOAD_DIR =
+
+ifdef PKG_EL_DIR
+BATCH_EXTRA = -eval "(setq load-path (cons (expand-file-name \"$(PKG_EL_DIR)\") load-path))"
+endif
 
 .SUFFIXES: .el .elc .texi
 SHELL = /bin/sh
@@ -372,16 +398,46 @@ distfile:
 	zip -r org-$(TAG).zip org-$(TAG)
 	gtar zcvf org-$(TAG).tar.gz org-$(TAG)
 
-pkg:
+pkg: 
 	@if [ "X$(PKG_TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
+	echo "Building $(PKG_FNAME).tar ..."
 	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
+	rm -rf $(PKG_FNAME) $(PKG_FNAME).tar
+	$(MKDIR) $(PKG_FNAME)
+	cp -r $(PKG_BASE_FILES) $(PKG_FNAME)
+	$(MKDIR) $(PKG_FNAME)/doc
+	cp -r $(PKG_DOC_FILES) $(PKG_FNAME)/doc
+	${MAKE} pkg-readme
+	echo "(define-package \"$(PKG_QNAME)\" \"$(PKG_TAG)\" \"$(PKG_DOC)\" $(PKG_REQ))" > $(PKG_FNAME)/$(PKG_QNAME)-pkg.el
+	tar cf $(PKG_FNAME).tar $(PKG_FNAME) --remove-files
+	${MAKE} pkg-upload
+
+pkg-readme: 
+	$(MKDIR) $(PKG_FNAME)	
+	cp $(PKG_README_ORG_FILE) $(PKG_FNAME)/README.org
+	$(BATCH)						\
+	--eval "(require 'org-exp)"				\
+	--eval "(require 'org-ascii)"				\
+	--visit=$(PKG_FNAME)/README.org				\
+	--eval "(org-export-as-ascii 3 t)"
+	cp $(PKG_FNAME)/README.txt $(PKG_FNAME)/README
+	rm -f $(PKG_FNAME)/README.txt $(PKG_FNAME)/README.org
+
+pkg-upload: 
+	@if [ "X$(PKG_UPLOAD_DIR)" = "X" ];					\
+	then echo "*** WARNING: Skipping Upload of $(PKG_FNAME).tar  ***";	\
+	else									\
+	echo "Uploading $(PKG_FNAME).tar to $(PKG_UPLOAD_DIR) ...";		\
+	$(MKDIR) $(PKG_UPLOAD_DIR);						\
+	$(BATCH) $(BATCH_EXTRA)							\
+	  --eval '(ignore)'							\
+	  --eval "(require 'package-x)"						\
+	  --eval '(setq package-archive-upload-base "$(PKG_UPLOAD_DIR)")'	\
+	  --eval '(setq package-update-news-on-upload nil)'			\
+	  --eval '(package-upload-file "$(PKG_FNAME).tar")';			\
+	fi
 
 makerelease:
 	@if [ "X$(TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
-- 
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

^ permalink raw reply related	[flat|nested] 4+ messages in thread
* [PATCH] ELPA: Support for building Package Variants and Package Upload.
@ 2011-05-28 13:55 Jambunathan K
  0 siblings, 0 replies; 4+ messages in thread
From: Jambunathan K @ 2011-05-28 13:55 UTC (permalink / raw)
  To: emacs-orgmode

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


Attaching an improvement to my earlier patch
- http://patchwork.newartisans.com/patch/377/

The earlier patch can now be ignored.

Jambunathan K.


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

From 2ba0a7341c7968f38086cec3d7d3e8f0a95960ad Mon Sep 17 00:00:00 2001
From: Jambunathan K <kjambunathan@gmail.com>
Date: Wed, 18 May 2011 23:55:13 +0530
Subject: [PATCH] ELPA: Support for building Package Variants and Package Upload.

* Makefile (PKG_TAG): Package version. Use YYMMDD as the
default version.
(PKG_SEP, PKG_FLAVOUR): New config variables for building
various flavours of org, for eg., org-odt20110518.tar,
(PKG_FILES): Removed
(PKG_LISP_FILES, PKG_INFO_FILES): These files end up in the root dir.
(PKG_DOC_FILES): Optional. These files end up in the doc dir.
(PKG_DATA_DIRS): Optional. Extra directories to be
distributed with tarball. For example, org-odt package uses
this to distribute rnc schema files, default styles file and
unit test files.
(PKG_README_ORG_FILE): README file.
(PKG_EL_DIR): Load path for package.el and
package-x.el. Useful if the build machine runs an Emacs
machine that doesn't ship with package manager (for example
Emacs-23.x)
(PKG_UPLOAD_DIR): Package tarball is copied here. This is
presumably the 'pub' dir of the webserver hosting the package.
(pkg-info, pkg-doc, pkg-data, pkg-readme, pkg-upload): New
targets subsumed within pkg target.
(pkg): Modified. Use the above targets.

* doc/ReleaseNotes.org: New file used to build package README
file.
---
 Makefile             |  124 ++++++++++++++++++++++++++++++++++++++++++++------
 doc/ReleaseNotes.org |   38 +++++++++++++++
 2 files changed, 147 insertions(+), 15 deletions(-)
 create mode 100644 doc/ReleaseNotes.org

diff --git a/Makefile b/Makefile
index 9693fd3..984c515 100644
--- a/Makefile
+++ b/Makefile
@@ -170,18 +170,58 @@ TEXIFILES   = doc/org.texi
 INFOFILES   = doc/org
 
 # Package Manager (ELPA)
+
+# Common Usage
+
+# |---------------------------------------+----------------------+--------------|
+# | Invocation                            | Output               | Side-Effects |
+# |---------------------------------------+----------------------+--------------|
+# | make pkg                              | org-20110518.tar     |              |
+# | make PKG_TAG=7.3 pkg                  | org-7.3.tar          |              |
+# | make PKG_FLAVOUR=odt pkg              | org-odt-20110518.tar |              |
+# |---------------------------------------+----------------------+--------------|
+
+# Advanced Usage
+
+# make PKG_EL_DIR="~/elisp" PKG_UPLOAD_DIR="~/packages/" PKG_TAG=7.3 pkg
+
+# Invocation shown above builds org-7.3.tar and uploads the same to
+# "~/packages" using package-x.el in "~/elisp/".
+
+ifndef PKG_TAG
 PKG_TAG = $(shell date +%Y%m%d)
+endif
+
+ifdef PKG_FLAVOUR
+PKG_SEP = -
+endif
+
+PKG_BNAME = org
+PKG_QNAME = $(PKG_BNAME)$(PKG_SEP)$(PKG_FLAVOUR)
+PKG_FNAME = $(PKG_QNAME)-$(PKG_TAG)
+
 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
+PKG_LISP_FILES = $(LISPFILES0)
+PKG_INFO_FILES = doc/org doc/dir
+PKG_DOC_FILES =  doc/org.pdf             \
+                 doc/org.html            \
+                 doc/orgguide.pdf        \
+                 doc/orgcard.txt         \
+                 doc/orgcard.pdf         \
+                 doc/orgcard_letter.pdf
+
+PKG_DATA_DIRS =
+PKG_README_ORG_FILE = doc/ReleaseNotes.org
+PKG_README_HTML_FILE = $(PKG_README_ORG_FILE:.org=.html)
+
+# PKG_EL_DIR =
+PKG_UPLOAD_DIR = packages
+
+ifdef PKG_EL_DIR
+BATCH_EXTRA = -eval "(setq load-path (cons (expand-file-name \"$(PKG_EL_DIR)\") load-path))"
+endif
 
 .SUFFIXES: .el .elc .texi
 SHELL = /bin/sh
@@ -402,14 +442,68 @@ distfile:
 
 pkg:
 	@if [ "X$(PKG_TAG)" = "X" ]; then echo "*** No tag ***"; exit 1; fi
+	echo "Building $(PKG_FNAME).tar ..."
 	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
+	rm -rf $(PKG_FNAME) $(PKG_FNAME).tar
+	$(MKDIR) $(PKG_FNAME)
+	cp -r $(PKG_LISP_FILES) $(PKG_FNAME)
+	${MAKE} pkg-info
+	${MAKE} pkg-doc
+	${MAKE} pkg-data
+	${MAKE} pkg-readme
+	echo "(define-package \"$(PKG_QNAME)\" \"$(PKG_TAG)\" \"$(PKG_DOC)\" $(PKG_REQ))" > $(PKG_FNAME)/$(PKG_QNAME)-pkg.el
+	tar cf $(PKG_FNAME).tar $(PKG_FNAME) --remove-files
+	${MAKE} pkg-upload
+
+pkg-data: $(PKG_DATA_DIRS)
+	@if [ "X$(PKG_DATA_DIRS)" = "X" ];			\
+	then echo "*** WARNING: PKG_DATA_DIRS not defined ***";	\
+	else 							\
+	git clean -dfx $<;					\
+	mkdir -p $(PKG_FNAME)/$<;				\
+	cp -r $</* $(PKG_FNAME)/$<;				\
+	fi
+
+pkg-info: $(PKG_INFO_FILES)
+	cp -r $(PKG_INFO_FILES) $(PKG_FNAME)
+
+pkg-doc: $(PKG_DOC_FILES)
+	@if [ "X$(PKG_DOC_FILES)" = "X" ];			\
+	then echo "*** WARNING: PKG_DOC_FILES not defined ***";	\
+	else 							\
+	$(MKDIR) $(PKG_FNAME)/doc;				\
+	cp -r $(PKG_DOC_FILES) $(PKG_FNAME)/doc;		\
+	fi
+
+pkg-readme:
+	$(MKDIR) $(PKG_FNAME)
+	cp $(PKG_README_ORG_FILE) $(PKG_FNAME)/README.org
+	$(BATCH)						\
+	--eval "(require 'org-ascii)"				\
+	--visit=$(PKG_FNAME)/README.org				\
+	--eval "(org-export-as-ascii 3 t)"
+	cp $(PKG_FNAME)/README.txt $(PKG_FNAME)/README
+	rm -f $(PKG_FNAME)/README.txt $(PKG_FNAME)/README.org
+
+pkg-upload:
+	@if [ "X$(PKG_UPLOAD_DIR)" = "X" ];					\
+	then echo "*** WARNING: Skipping Upload of $(PKG_FNAME).tar  ***";	\
+	else									\
+	echo "Uploading $(PKG_FNAME).tar to $(PKG_UPLOAD_DIR) ...";		\
+	$(MKDIR) $(PKG_UPLOAD_DIR);						\
+	rm -f $(PKG_UPLOAD_DIR)/archive-contents;				\
+	$(BATCH) $(BATCH_EXTRA)							\
+	  --eval '(toggle-debug-on-error)'					\
+	  --eval "(require 'package-x)"						\
+	  --eval '(setq package-archive-upload-base "$(PKG_UPLOAD_DIR)")'	\
+	  --eval '(setq package-update-news-on-upload nil)'			\
+	  --eval '(package-upload-file "$(PKG_FNAME).tar")';			\
+	$(BATCH)								\
+	--eval "(require 'org-html)"						\
+	--visit=$(PKG_README_ORG_FILE)						\
+	--eval "(org-export-as-html 3 t)";					\
+	mv $(PKG_README_HTML_FILE) $(PKG_UPLOAD_DIR)/README.html;		\
+	fi
 
 cleanall:
 	${MAKE} clean
diff --git a/doc/ReleaseNotes.org b/doc/ReleaseNotes.org
new file mode 100644
index 0000000..af6b458
--- /dev/null
+++ b/doc/ReleaseNotes.org
@@ -0,0 +1,38 @@
+#+TITLE:	Readme
+#+AUTHOR:	Bastien Guerry
+#+EMAIL:	emacs-orgmode@gnu.org
+#+DATE:		%Y-%m-%d %T %Z
+#+DESCRIPTION:
+#+KEYWORDS:
+#+LANGUAGE:  en
+#+OPTIONS:   H:3 num:t toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t
+#+OPTIONS:   TeX:t LaTeX:dvipng skip:nil d:nil todo:t pri:nil tags:not-in-toc
+
+#+EXPORT_SELECT_TAGS: export
+#+EXPORT_EXCLUDE_TAGS: noexport
+#+LINK_UP:   
+#+LINK_HOME: 
+#+XSLT:
+
+
+* About Orgmode
+
+Org-mode is a mode for keeping notes, maintaining ToDo lists, and
+doing project planning with a fast and effective plain-text system.
+
+This package contains a daily build of Org-mode.
+
+Org-mode develops organizational tasks around NOTES files that contain
+information about projects as plain text.  Org-mode is implemented on
+top of outline-mode, which makes it possible to keep the content of
+large files well structured.  Visibility cycling and structure editing
+help to work with the tree.  Tables are easily created with a built-in
+table editor.  Org-mode supports ToDo items, deadlines, time stamps,
+and scheduling.  It dynamically compiles entries into an agenda that
+utilizes and smoothly integrates much of the Emacs calendar and diary.
+Plain text URL-like links connect to websites, emails, Usenet
+messages, BBDB entries, and any files related to the projects.  For
+printing and sharing of notes, an Org-mode file can be exported as a
+structured ASCII file, as HTML, or (todo and agenda items only) as an
+iCalendar file.  It can also serve as a publishing tool for a set of
+linked webpages.
-- 
1.7.2.3


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



-- 

^ permalink raw reply related	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2011-05-28 13:55 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2010-11-12 13:14 [PATCH] (ELPA): Support for building Package Variants and Package Upload Jambunathan K
2010-11-12 15:09 ` Carsten Dominik
2010-11-12 16:53   ` Jambunathan K
2011-05-28 13:55 [PATCH] ELPA: " Jambunathan K

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.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).