[MERGE][Bug #124853] bzr help debug should list debug options

[Daniel Watkins]

On Wed, 2007-08-22 at 20:45 +0100, James Westby wrote:
> Two questions, first why does "hooks" have no comment? Second there is
> no test for this. It's not to important, but a blackbox smoke test would
> be good, you can see the tests for some of the other topics.
Hooks has no comment because there is no comment in bzrlib/debug.py.  If
someone would be kind enough to give me a comment for hooks, I'll pop it
in.

Attached is a bundle with a test added.


Regards,
-- 
Daniel Watkins (Odd_Bloke) <D.M.Watkins at warwick.ac.uk>
University of Warwick Christian Focus President
University of Warwick Computing Society WUGLUG Liaison Officer
-------------- next part --------------
# Bazaar merge directive format 2 (Bazaar 0.90)
# revision_id: d.m.watkins at warwick.ac.uk-20070822195912-\
#   kx3opmuscu7ybxef
# target_branch: file:///home/daniel/devel/bzr/bzr.dev/
# testament_sha1: da3a30a76779fb1fd80e5159867773b9d56d7a12
# timestamp: 2007-08-22 21:59:24 +0200
# base_revision_id: pqm at pqm.ubuntu.com-20070822052832-nxby1d1plok4syek
# 
# Begin patch
=== modified file 'NEWS'
--- NEWS	2007-08-22 05:28:32 +0000
+++ NEWS	2007-08-22 19:29:46 +0000
@@ -44,6 +44,9 @@
     * ``send`` now sends the directive as an attachment by default.
       (Aaron Bentley, Luk?? Lalinsk?, Alexander Belchenko)
 
+    * ``bzr help debug-flags`` now contains information on how to use debug
+      flags and an incomplete list of them.  (Daniel Watkins, #124853)
+
   API BREAKS:
 
    * ``Branch.append_revision`` is removed altogether; please use 

=== modified file 'bzrlib/help_topics.py'
--- bzrlib/help_topics.py	2007-08-07 01:58:45 +0000
+++ bzrlib/help_topics.py	2007-08-22 19:27:48 +0000
@@ -498,6 +498,23 @@
 """
 
 
+_debug_flags = \
+"""Debug Flags
+
+Set of flags that enable different debug behaviour.  These are set with eg
+``-Dlock`` on the bzr command line.
+
+Options include:
+ * evil - capture call sites that do expensive or badly-scaling operations.
+ * error - show stack traces for all top level exceptions
+ * hooks 
+ * hpss - trace smart protocol requests and responses
+ * index - trace major index operations
+ * lock - trace when lockdir locks are taken or released
+
+"""
+
+
 topic_registry.register("revisionspec", _help_on_revisionspec,
                         "Explain how to use --revision")
 topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
@@ -527,6 +544,8 @@
                         'Environment variable names and values')
 topic_registry.register('files', _files,
                         'Information on configuration and log files')
+topic_registry.register('debug-flags', _debug_flags,
+                        'Information on debug flags')
 
 
 class HelpTopicIndex(object):

=== modified file 'bzrlib/tests/blackbox/test_help.py'
--- bzrlib/tests/blackbox/test_help.py	2007-08-06 08:25:46 +0000
+++ bzrlib/tests/blackbox/test_help.py	2007-08-22 19:59:12 +0000
@@ -91,6 +91,13 @@
         expected = help_as_plain_text(_status_flags)
         self.assertEqual(expected, out)
 
+    def test_help_debug_flags(self):
+        """Smoke test for 'bzr help debug-flags'"""
+        out, err = self.run_bzr('help debug-flags')
+        from bzrlib.help_topics import help_as_plain_text, _debug_flags
+        expected = help_as_plain_text(_debug_flags)
+        self.assertEqual(expected, out)
+
     def test_help_commands(self):
         dash_help  = self.run_bzr('--help commands')[0]
         commands   = self.run_bzr('help commands')[0]

# Begin bundle
IyBCYXphYXIgcmV2aXNpb24gYnVuZGxlIHY0CiMKQlpoOTFBWSZTWeKMhM8ABO1/gFQQBABZ9///
dyOMhP////BgCU+eTStAAAX1gTqxk6MgtmhDKCFPZUeUep6nlPEwnpRmptQNGgNDQADmBMTQYTJk
yZGEwTTTIxMAQwHMCYmgwmTJkyMJgmmmRiYAhgEiQSI9Am0aUxNqYQ0wTI0aNGjQ9QaDalPREQek
9T0hpo9RkAaHqGhoyAYTQEkgTEAITIZEyZogam0nqR6jTIDCPLQSgvtHXVPTv+611ZSGQpTs196I
AkV1qhZZF4OjjkRXI9HYxp9o7EGQmQQTK7uaGd2MlYSxcJFne2nfWKdrCt02JuNmaDNkgqgyNcIr
/ZKlgv0h+8v13i/NapkNtpv8eItk1aF0blCctGqcr2TY2RStNKosfozaNFwdV5zVsMC8XLDNz/L6
aaV/Sd7wT2IlPY8WIyctVPGc2sMuXJfws1DZK/IaGbPHyeTWcsCVlj5VTH/Cqkne7CyGVJk3aXQW
bDMDZU2ydtYvlYLQvePFIsmtZQyKAWC5/Rm1HOYnOpDPVfHB9IUhkLaL9tTzz7drdGGpGlQ4gitK
3LVRUmGYSPEemXFHq72G9w3TydLqhmP88fWwUCUm+HCKNDp6z38gmTDUBYIOn5ZjzrQeXkDcDiUA
LcNx3FO2Oq6JjaMdZ2HgJBsxH4BktABUJCmjDGyegfgkJgF2i7aSo5znOdz/skqbiaQzA2FIUa91
vSoKl5ISCwoPeqTKGAdRa1cTA/YkHEJoIHWwzCS0tElbF8nj3itTpFxAcMVl62lx24HpmK68g9KH
R05SiVGIoNCWknSK/FWisPueydOc8aV2bVH9DYU3Q3CiUYypFEKFNKw1Kfk9eFAFe68WI8oXHWFp
IMwwwxHUvFYFc10CQbjILipHCttydEsAWwErS4oXlNjkS6RihgghQHvue5BoMREXGJX71LzEYvMi
x48xQcDzQZZ4mOeg15mSdcWmIQDeRIGJGRMufIqYGpAsIFxvcbjErcWEyReF6yLyhcbkHwE9+8dR
nJa6vE4vHz377Stga6jipm2Wo/NA9jIdigqjoMpw3ilm8Y0KDiB80HiEN3A3Ce60sG0Tia0Iw3Y2
PMJjgfqOGVukJPnoWFhwC25xrgHAyIwIm0Wci+/AzNBiwmYYoLzPLFmJuqwiyBYMy+FCeBTHYgtL
jYakeBiTJGO9LIcaGJAtPGOWE1SRoklF+1RkWmhEjtkPLxiqCuQ7HoI2l/QYmIyu0KBoguKhvQOI
EzmKJwLqNVyCwvyKFgzkJYF5kFvU8cUhVFDxaj1IuW4onWlKkhhil1Y1ZnQLTfMUCqCLINTIvKoN
CIsCpAvK2vJWYDGJUkbT9z732lWVwNitl4woIIBqLERLtF+O4YVEwg70wtq4rAwMAogafGouGmex
psbJygb1rwFyLnUlRQKYckHILgScETqdKLMJMl9eZYPFuOOYopw7ZNQ7P4nFbUwqnpM8Vlil1ItD
KywCG0jcIXJHRTcMzBEqH4hI+d93RE7jzuBdp3nM7k8eESB5GpE7yB/LyJU03pC8PkgbxDd0fQmY
fFjgKwRFIJHi3z4/VurIUU4gTTixvYN6CesDJAS/NIX8GW2HWMguPFKwBaEfr1ZnWcR+h8zQ6xw4
ieg49CAxt9xI4j+0b4T8Ry3wYA7AuOYvsEfnzOVIeaD7sr0IMi0vNTYZnMcbSbzhzvLCK95t2P5q
fgg8JkhJRAz1FO1BKQbYTGVDMYhMmNMyR1l4P4DIBwMhPNe6ouNBhSvKoNo4SaZqMYJgGULEo5Re
PkTCmYm5BtIaLWRjIC+5aWVZtCRgDpOPypD2otxlilcPeKy7901j5ik6OJ0Uz0HAXFvWoj0A9QL9
5EpRIVgjmE6ApmlBJz4ViprwoTeJRM3E61NwdjzHX6B5B2x5ZLakHKuslYgZJatrj1OUjha8oOgC
acLxXV6RQEy8PznxNyumAsR36+zrUi1ZbjwYGHOVU3ed5+BxOR4BFBM5ER49L5DG9LCfVdSzB2dB
H6Z3tqSZuyENauVcGhqbTYudo6ADsoQgNin5+RXviBSLHt4uwaypj7fb2uw7vKy1lbE3iG8rz3nx
f0K1ITwxEnhYLzS9UH07kESIsDgMvQQxfi49XwURgS/Y+nvU1NbVVMhDJa9pkkaqvKNNZJQxGoSf
hopEoG6xAEMCKw8kDgdBS3iMkkoRu8BfZBSiJXlfBBig+R++YByMCFqC0gdDl2DrWGWqd7MSCQB5
LFW9OcWBviHMBX4Dwt3axEZC5rsUxSXfcHrYvETyucTgUzJCbgaRoYKZPGKikmDQprKR/mG+qBlL
kDMBgKptNpCeEGQQgbSW0DkEw4beJ0A3YW2qAbLr4sItUkybIchHsmDSJ7WXTHAnI8xdWRBo/k0h
DxFPeM9BhZrfP01MF7jeg2oqwdG5OSouS5LrQeyCQuxUSDxHnqDxdz91/yD0tV6vEyw07v517hep
3oM8QJ/rSC4sSBuurow0cjkEBHUnkJG9YNlGCAcaL0TlqmQSVK2ltojWUJcNc4LM6FmKIGJsWOSQ
pLA0Vq9K3exVAlhF+eUdxKROORQw4IsJ4qZE+wVjEvr79nGdr3i0E7gAmg9XoH26MK1iwYIMnTEM
53eEaMVNknDnd+LM48EGi8FMVkwoUFEGKFhJq4llVTJYcW+4zjFiVIRaamKBY1c2wAcQbjMLxFyC
AZueMKjIKpgrUgLAMRc+oPPJ/aIOP9ZJC7FWIbMmu5i1HmnDVA2jALgRRzSFgAp3pCa080GBQmZi
uB8BX9zxLiWqq3i3PCYd4vUZSXMivyF0Bkg3Yhgs0FqXcg/4u5IpwoSHFGQmeA==
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20070822/f6f741b3/attachment.pgp