Rev 2556: Increase docs in response to review feedback. in http://people.ubuntu.com/~robertc/baz2.0/integration

[Robert Collins]

At http://people.ubuntu.com/~robertc/baz2.0/integration

------------------------------------------------------------
revno: 2556
revision-id: robertc at robertcollins.net-20070628063203-lr39jqb65223ts09
parent: robertc at robertcollins.net-20070628032159-ru3ztg712ns2dpip
committer: Robert Collins <robertc at robertcollins.net>
branch nick: integration
timestamp: Thu 2007-06-28 16:32:03 +1000
message:
  Increase docs in response to review feedback.
modified:
  bzrlib/commit.py               commit.py-20050511101309-79ec1a0168e0e825
  bzrlib/hooks.py                hooks.py-20070325015548-ix4np2q0kd8452au-1
=== modified file 'bzrlib/commit.py'
--- a/bzrlib/commit.py	2007-06-28 03:21:59 +0000
+++ b/bzrlib/commit.py	2007-06-28 06:32:03 +0000
@@ -493,6 +493,11 @@
         else:
             old_revid = bzrlib.revision.NULL_REVISION
         for hook in Branch.hooks['post_commit']:
+            # show the running hook in the progress bar. As hooks may
+            # end up doing nothing (e.g. because they are not configured by
+            # the user) this is still showing progress, not showing overall
+            # actions - its up to each plugin to show a UI if it want's to
+            # (such as 'Emailing diff to foo at example.com').
             self.pb_stage_name = "Running post commit hooks [%s]" % \
                 Branch.hooks.get_hook_name(hook)
             self._emit_progress()

=== modified file 'bzrlib/hooks.py'
--- a/bzrlib/hooks.py	2007-06-28 03:08:53 +0000
+++ b/bzrlib/hooks.py	2007-06-28 06:32:03 +0000
@@ -39,6 +39,9 @@
         """Get the name for a_callable for UI display.
 
         If no name has been registered, the string 'No hook name' is returned.
+        We use a fixed string rather than repr or the callables module because
+        the code names are rarely meaningful for end users and this is not 
+        intended for debugging.
         """
         return self._callable_names.get(a_callable, "No hook name")