Initial commit (Release 0.4)

Author: ctmarinas

AUTHORS

@@ -0,0 +1,2 @@
+Catalin Marinas <[email protected]>
+	http://www.procode.org/about.html

COPYING

@@ -0,0 +1,153 @@
+2005-07-09  Catalin Marinas  <[email protected]>
+
+	* Release 0.4
+
+2005-07-09  Peter Osterlund <[email protected]>
+
+	* Fix spelling errors
+
+2005-07-08  Catalin Marinas  <[email protected]>
+
+	* stgit/main.py (diff): Add '--stat' option to 'diff'
+	(files): 'files' command implemented
+
+2005-07-08  Peter Osterlund <[email protected]>
+
+	* stgit/git.py (diffstat): %(diffstat)s variable support in the
+	patch export template
+
+2005-07-07  Catalin Marinas  <[email protected]>
+
+	* stgit/main.py (resolved): Implemented a 'resolved' command to
+	mark conflicts as solved. The 'status' command now shows the
+	conflicts as well. 'refresh' fails if there are conflicts
+
+2005-07-06  Catalin Marinas  <[email protected]>
+
+	* stgit/stack.py (edit_file): Added support for patchdescr.tmpl
+
+	* stgit/main.py (export): Added support for more variables in the
+	patchexport.tmpl file
+
+	* stgit/stack.py (Patch): Add support for author/comitter default
+	details configuration
+
+	* stgit/main.py (push): '--undo' option added to push. This option
+	allows one to undo the last push operation and restores the old
+	boundaries of the patch (prior to the push operation)
+	(pop): pop optimised to switch directly to the last patch to be
+	popped
+
+2005-07-05  Catalin Marinas  <[email protected]>
+
+	* stgit/main.py (pop): add '--to' option to 'pop'
+	(push): add '--to' and '--reverse' options to 'push'
+
+	* gitmergeonefile.py: Added support for 'keeporig' option which
+	selects whether to delete or not the original files after a failed
+	merge
+
+2005-07-04  Catalin Marinas  <[email protected]>
+
+	* Add support for configurable merge tool via stgitrc
+
+	* Add support for configuration file (/etc/stgitrc, ~/.stgitrc,
+	.git/stgitrc)
+
+2005-07-02  Catalin Marinas  <[email protected]>
+
+	* stgit/main.py (export): Added support for the patch description
+	template. At the moment, only the '%(description)s' variable is
+	supported
+
+2005-07-01  Catalin Marinas  <[email protected]>
+
+	* stgit/main.py (refresh): Now it also checks for head != top
+	(export): Add the patch description to the exported patch files
+
+2005-06-30  Catalin Marinas  <[email protected]>
+
+	* Fix exception reporting when the .git/HEAD link is not valid
+
+	* Empty patches are now marked
+
+2005-06-28  Catalin Marinas  <[email protected]>
+
+	* Release 0.3
+
+	* stgit/stack.py (Series.push_patch): if the merge with the new
+	base failed, inform the user that "refresh" should be run after
+	fixing the conflicts
+
+	* stgit/main.py (new): checks for local changes and head != top
+	added
+
+	* StGIT is now closer to Quilt in functionality. The 'commit'
+	command was removed ('refresh' is used instead).
+
+2005-06-25  Catalin Marinas  <[email protected]>
+
+	* stack.py modified to include all the series functions the Series
+	class
+
+2005-06-24  Catalin Marinas  <[email protected]>
+
+	* stgit/git.py (commit): commit tells before invoking the editor
+	and shows the return error code but without exiting if it is
+	non-zero
+
+2005-06-23  Catalin Marinas  <[email protected]>
+
+	* stgit/main.py (push): --number option added to push
+	(pop): --number option added to push
+
+2005-06-22  Catalin Marinas  <[email protected]>
+
+	* gitmergeonefile.py: temporary files are placed in <path>.local,
+	<path>.older and <path>.remote and only removed if the merge
+	succeeded
+
+2005-06-21  Catalin Marinas  <[email protected]>
+
+	* stgit/main.py (delete): 'delete' now requires the explicit patch
+	name as a safety measure
+
+	* stgit/stack.py (pop_patch): sys.stdout.flush() added after the
+	first print
+	(push_patch): fix bug with 'push' not warning for empty patches
+
+	* stgit/stack.py (push_patch): sys.stdout.flush() added after the
+	first print
+
+2005-06-20  Catalin Marinas  <[email protected]>
+
+	* Release 0.2
+
+	* stgit/stack.py (delete_patch): bug when deleting the topmost
+	patch fixed
+
+	* top/bottom files are backed up to top.old/bottom.old
+	automatically. The 'diff' command supports them as well
+
+	* stg-upgrade.sh: upgrades the .git structure from stgit-0.1 to
+	stgit-0.2
+
+2005-06-19  Catalin Marinas  <[email protected]>
+
+	* Multiple heads and bases are now supported. A different series
+	is available for each head
+
+	* gitmergeonefile.py: fix bug caused by not updating the cache
+	when merging with diff3
+
+	* stgit/stack.py: 'push' command reports a warning if the patch is
+	empty
+
+	* stgit/git.py: commit supports an 'allowempty' parameter
+
+	* os.path.join() used instead '+' for concatenating path names
+
+2005-06-15  Catalin Marinas  <[email protected]>
+
+	* Release 0.1
+

ChangeLog

@@ -0,0 +1,7 @@
+For basic installation:
+
+	python setup.py install
+
+For more information:
+
+	http://docs.python.org/inst/inst.html

INSTALL

@@ -0,0 +1,2 @@
+include README MANIFEST.in AUTHORS COPYING INSTALL ChangeLog TODO stgitrc
+include examples/*.tmpl

MANIFEST.in

@@ -0,0 +1,171 @@
+Stacked GIT
+-----------
+
+StGIT is a Python application providing similar functionality to Quilt
+(i.e. pushing/poping patches to a stack) on top of GIT. These
+operations are performed using the GIT merge algorithms.
+
+Note that StGIT is not an SCM interface for GIT. Use the GIT commands
+or some other tools like Cogito for this.
+
+For the latest version see http://www.procode.org/stgit/
+
+
+Basic Operations
+----------------
+
+For a full list of commands:
+
+	stg help
+
+For help on individual commands:
+
+	stg <cmd> (-h | --help)
+
+To initialise a tree (the tree must have been previously initialised
+with GIT):
+
+	stg init
+
+To add/delete files:
+
+	stg add [<file>*]
+	stg rm [<file>*]
+
+To inspect the tree status:
+
+	stg status
+
+To get a diff between 2 revisions:
+
+	stg diff [-r rev1[:[rev2]]]
+
+A revision name can be of the form '([patch]/[bottom | top]) | <tree-ish>'
+If the patch name is not specified but '/' is passed, the topmost
+patch is considered. If neither 'bottom' or 'top' follows the '/', the
+whole patch diff is displayed (this does not include the local
+changes).
+
+Note than when the first patch is pushed to the stack, the current
+HEAD is saved in the .git/refs/heads/base file for easy reference.
+
+To create/delete a patch:
+
+	stg new <name>
+	stg delete [<name or topmost>]
+
+The 'new' command also sets the topmost patch to the newly created
+one.
+
+To push/pop a patch to/from the stack:
+
+	stg push [<name or first unapplied>]
+	stg pop [<name or topmost>]
+
+Note that the 'push' command can apply any patch in the unapplied
+list. This is useful if you want to reorder the patches.
+
+To add the patch changes to the tree:
+
+	stg refresh
+
+To inspect the patches applied:
+
+	stg series
+	stg applied
+	stg unapplied
+	stg top
+
+To export a patch series:
+
+	stg export [<dir-name or 'patches'>]
+
+The 'export' command supports options to automatically number the
+patches (-n) or add the '.diff' extension (-d).
+
+StGIT does not yet provide support for cloning or pulling changes from
+a different repository. Until this becomes available, run the
+following commands:
+
+	stg pop -a
+	your-git-script-for-pulling-and-merging
+	stg push -a
+
+You can also look in the TODO file for what's planned to be
+implemented in the future.
+
+
+Directory Structure
+-------------------
+
+.git/
+  objects/
+    ??/
+
+refs/
+  heads/
+    master		- the master commit id
+    ...
+  bases/
+    master		- the bottom id of the stack (to get a big diff)
+    ...
+  tags/
+    ...
+  branches/
+    ...
+  patches/
+    master/
+      applied		- list of applied patches
+      unapplied		- list of not-yet applied patches
+      current		- name of the topmost patch
+      patch1/
+        first		- the initial id of the patch (used for log)
+        bottom		- the bottom id of the patch
+        top		- the top id of the patch
+      patch2/
+      ...
+    ...
+
+HEAD			-> refs/heads/<something>
+
+
+A Bit of StGIT Patch Theory
+---------------------------
+
+We assume that a patch is a diff between two nodes - bottom and top. A
+node is a commit SHA1 id or tree SHA1 id in the GIT terminology:
+
+P - patch
+N - node
+
+P = diff(Nt, Nb)
+
+	Nb - bottom (start) node
+	Nt - top (end) node
+	Nf - first node (for log generation)
+
+For an ordered stack of patches:
+
+P1 = diff(N1, N0)
+P2 = diff(N2, N1)
+...
+
+Ps = P1 + P2 + P3 + ... = diff(Nst, Nsb)
+
+	Ps  - the big patch of the whole stack
+	Nsb - bottom stack node (= N0)
+	Nst - top stack node (= Nn)
+
+Applying (pushing) a patch on the stack (Nst can differ from Nb) is
+done by diff3 merging. The new patch becomes:
+
+P' = diff(Nt', Nb')
+Nb' = Nst
+Nt' = diff3(Nst, Nb, Nt)
+
+(note that the diff3 parameters order is: branch1, ancestor, branch2)
+
+The above operation allows easy patch re-ordering.
+
+Removing (popping) a patch from the stack is done by simply setting
+the Nst to Nb.

README

@@ -0,0 +1,27 @@
+The TODO list for the short term:
+
+- tag (snapshot) command
+- pull command (no longer rely on cogito or plain git)
+- log command (it should also show the log per single patch)
+- import command to import a series of patches or a single patch or a
+  patch from a different branch in the same tree
+- better help for commands
+- bug reporting tool
+
+
+Other things after the list above is completed:
+
+- fold command (to merge 2 patches into one)
+- automatic e-mail sending with the patches
+- release 1.0
+
+
+The future, when time allows or someone else does it:
+
+- patches command to show the patches modifying a file
+- patch dependency tracking
+- multiple heads in a patch - useful for forking a patch,
+  synchronising with other patches (diff format or in other
+  repositories)
+- remove the old base of the patch if there are no references to it
+- write bash-completion script for the StGIT commands

TODO

@@ -0,0 +1,3 @@
+
+
+Signed-off-by: Your Name <[email protected]>

examples/patchdescr.tmpl

@@ -0,0 +1,5 @@
+%(description)s
+---
+
+%(diffstat)s
+