short and long log messages

Alexander Belchenko bialix at ukr.net
Thu May 18 05:47:28 BST 2006


John Arbash Meinel пишет:
> Matthieu Moy wrote:
>> Hi,
> 
> ...
> 
>> AFAIK, there is no such thing in bzr. Indeed, a user can use the first
>> line of the log message as a short description, and the next as a long
>> one. I think this is the way to do it, but this deserve a little support
>> in bzr itself: the log formatter for "--line" and "--short" should split
>> the message at the first newline, instead of truncating after a number
>> of characters. The patch below does this for --line.
>>
>> Also, this should be documented as such (in the tutorial probably).
>>
>> Any opinion?
>>
> 
> I think it would be a reasonable best practices. Just like how we
> document functions:
> 
> """summary line.
> 
> more detailed stuff here
> """
> 
> And we could have log --line do this. But it might be better to follow
> Alexander's suggestion and have a "log --log-format=summary", which
> would just output the first line.

I want to clarify my point.

I never before use --line log formatter because it does not show 
revisions numbers. Few days ago I fix this behavior and now all can use 
--line for real work.

But I have a lot of history in my branches that does not follow this 
summary rule in comments. So, I think this change in --line behavior is 
too radically. I'd prefer to have another long option --summary instead.

But of course if there will be +2 on Matthieu proposal -- I'll give up.

--
Alexander





More information about the bazaar mailing list