Re: [PATCH] gitweb: Add js=1 before an URI fragment to fix line number links

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 27, 2011, 17:40 UTC
Message-ID: <7vy5x9x4ss.fsf@alter.siamese.dyndns.org>
In-Reply-To: <20110927094947.10955.qmail@stuge.se>

Peter Stuge <peter@stuge.se> writes:

Show 6 quoted lines

> I disagree, but I agree with you if we qualify that a little. The
> right balance is a matter of subjective review, so the only way it
> can be practiced with relevance is by actually working with the same
> reviewers for a while, to learn what they consider right.
>
> It can absolutely not be practiced out of context,...

You are right that you need to practice in the context of working in the Git project to explain your change with the right amount of details when preparing a change for the Git project, and the same goes for the openocd project.

We aim to write our commit log messages primarily for future developers who want to read "git log -p" output and understand why these changes had to be made, to help them avoid intentionally breaking what the old commit wanted to achieve when they want to modify the existing code 6 months down the road. Your reviewers aim to make sure that your log message gives sufficient information to such future developers, as opposed to themselves while reviewing the patch and the issue is still fresh in their head.

I suspect that the target audience of log message may even be different depending on the project, and openocd may not work that way, and that is perfectly fine.