[PING][MERGE] help topics

[Goffredo Baroncelli]

On Friday 10 November 2006 22:34, you (John Arbash Meinel) wrote:
> Goffredo Baroncelli wrote:
> > [...]
> >> 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.
Done

> 
> 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
done

> 
> 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.
done

> 
> 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.

I protected the import with a try/except clause. So even tough the transport 
fails, bzr doesn't crash and show a message like

    This transport is currently unavailable and its help wont be displayed.

> 
> 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.
I agree, but I don't think that, has to be done with this change. 
The problem which you highligt is not how handle the transports help, but how 
handle the transports registration.

However if you think that is time to update the transport to the Register 
class, I will work a bit on it.

> 
> 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.

I agree, my english is very bad... :) 


> 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.

Enclose, there is the patch, adjusted with your suggestion. 
On the basis of our previous discussion, the help is based on the value of the 
transport.help_txt field; if it doens't exists, then the help is based on the 
__doc__ attribute.
So we can updated the help content in the transport independently.
  
> John
> =:->
Goffredo
-- 
gpg key@ keyserver.linux.it: Goffredo Baroncelli (ghigo) 
<kreijack_AT_inwind.it>
Key fingerprint = CE3C 7E01 6782 30A3 5B87  87C0 BB86 505C 6B2A CFF9
-------------- next part --------------
A non-text attachment was scrubbed...
Name: transport-topic.diff
Type: text/x-diff
Size: 34560 bytes
Desc: not available
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20061113/7cebeb47/attachment.bin 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20061113/7cebeb47/attachment.pgp