[PING][MERGE] help topics

[John Arbash Meinel]

Goffredo Baroncelli wrote:
> On Monday 06 November 2006 21:57, you (Goffredo Baroncelli) wrote:
>> Hi all,
>>
>> the enclosed patch was written by me and John Arbash with some modifications 
>> suggested by Richard Wilbur.
>>
> [...]
>> If the patch will be accepted, I will add 
>> the "transports topic" also...
> 
> Enclosed the patch mentioned above; the transports description should be 
> improved :-).
> 
> 
> $ ./bzr help transport
> 

Well, I'd like to see a few things here.

1) Probably the transport listings should be in sorted order. That way
you get 'http+pycurl://' next to 'http+urllib://' rather than being in
random order.

2) I think we need a way to hide some protocols. You use the presence of
'//' to hide the decorators. Though you really should do:

if not proto.endswith('://'):
  continue

rather than

if proto and len(proto) > 2 and proto[-2:] == '//': continue

Though still, I see a use in having transport decorators. We generally
only use them in the test suite, but eventually we will be adding
'chroot+' which might be generally useful for people.

3) This will force importing all of the transports, which may not have
their dependencies met. So if you don't have pycurl or paramiko
installed, then 'bzr help transports' will fail.

4) I think the real fix is to change the registration stuff to use a
class derived from Regsitry, which can store the help, rather than
having to change all of your stuff to import if it is a certain type of
module, etc.

5) And I definitely agree that we need to improve the transport
documentation, but I wouldn't strictly place that on you. If we get the
functionality, someone (me?) can clean up the actual text of the
documentation.

Are you interested in doing some of this, and do you feel comfortable
doing so? If not, I can put some of it on my TODO list, it is just
always nice to get help from others.

John
=:->


-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 254 bytes
Desc: OpenPGP digital signature
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20061110/6030da23/attachment.pgp