Rev 3031: (John Arbash Meinel) doc update for post-push hook. in file:///home/pqm/archives/thelove/bzr/%2Btrunk/

[Canonical.com Patch Queue Manager]

At file:///home/pqm/archives/thelove/bzr/%2Btrunk/

------------------------------------------------------------
revno: 3031
revision-id:pqm at pqm.ubuntu.com-20071126224137-gnhd7r5hx7f0064k
parent: pqm at pqm.ubuntu.com-20071126220540-8eco84avp18lelr8
parent: john at arbash-meinel.com-20071126184333-6yq2kjjrrige0th4
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Mon 2007-11-26 22:41:37 +0000
message:
  (John Arbash Meinel) doc update for post-push hook.
modified:
  doc/en/user-reference/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
    ------------------------------------------------------------
    revno: 3026.2.1
    revision-id:john at arbash-meinel.com-20071126184333-6yq2kjjrrige0th4
    parent: pqm at pqm.ubuntu.com-20071126151329-pnmm49obwettpwcd
    committer: John Arbash Meinel <john at arbash-meinel.com>
    branch nick: bzr.dev
    timestamp: Mon 2007-11-26 12:43:33 -0600
    message:
      Updated post-push hook to have the correct info
    modified:
      doc/en/user-reference/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
=== modified file 'doc/en/user-reference/hooks.txt'
--- a/doc/en/user-reference/hooks.txt	2007-09-02 05:37:08 +0000
+++ b/doc/en/user-reference/hooks.txt	2007-11-26 18:43:33 +0000
@@ -8,12 +8,33 @@
 Run after ``push`` has completed.
 
 The hook signature is (push_result), containing the members
-(source, local, master, old_revno, old_revid, new_revno, new_revid)
-where local is the local target branch or None, master is the target 
-master branch, and the rest should be self-explanatory. The source
-is read-locked and the target branches are write-locked. Source will
-be the local low-latency branch.
-
+
+  source_branch
+    Where the data is being pushed from (read locked).
+    This should be the lowest latency branch.
+
+  target_branch
+    The direct location where data is being sent (write locked).
+
+  master_branch
+    Either target_branch, or if the target is a bound branch, it
+    will be the master location (write locked).
+
+  local_branch
+    If the target is a bound branch, this will be the target
+    branch, else it will be None.
+
+  old_revno
+    The revision number (eg 10) of the branch before the push.
+
+  old_revid
+    The revision id (eg joe at foo.com-1234234-aoeua34) before the push.
+
+  new_revno
+    The revision number (eg 12) of the branch after the push.
+
+  new_revid
+    The revision id (eg joe at foo.com-5676566-boa234a) after the push.
 
 post_pull
 #########