git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Johannes Sixt <j.sixt@viscovery.net>
To: Peter Stuge <peter@stuge.se>
Cc: Junio C Hamano <gitster@pobox.com>, git@vger.kernel.org
Subject: Re: [PATCH] gitweb: Add js=1 before an URI fragment to fix line number links
Date: Tue, 27 Sep 2011 08:44:03 +0200	[thread overview]
Message-ID: <4E8170B3.8040205@viscovery.net> (raw)
In-Reply-To: <20110926222801.14985.qmail@stuge.se>

Am 9/27/2011 0:28, schrieb Peter Stuge:
> Junio C Hamano wrote:
>> You don't have to explain these to *me* specifically as a response
>> to this thread. What I meant was that your patch should have these
>> necessary descriptions in its proposed commit log message.
> 
> IMO not so neccessary if one knows a little web and javascript, which
> is probably likely for a gitweb change..
> 
> It's a simple fix of links broken by manual URI manipulation that
> didn't consider fragments. Is the subject description really not
> enough?

No, it is not. The target audience of a commit message are people like I
am. I do know a bit of Perl, and a bit of Javascript; I know how an URL is
structured; I would find my way through the gitweb code if the need
arises. But I am not an expert in any of these areas.

The subject alone is not sufficient because I do not know for sure what an
"URI fragment" is or what role line numbers in gitweb's links play. The
explanations and examples you gave in a later email were very
enlightening, and they would be very helpful if *I* am forced to hack
gitweb, and if I need to understand why this particular change was good.

Finding the right balance between verbosity and terseness needs practice,
but to write *no* justification is practically always wrong.

-- Hannes

  reply	other threads:[~2011-09-27  6:44 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-09-26 18:10 [PATCH] gitweb: Add js=1 before an URI fragment to fix line number links Peter Stuge
2011-09-26 19:27 ` Junio C Hamano
2011-09-26 19:46   ` Peter Stuge
2011-09-26 21:14     ` Junio C Hamano
2011-09-26 22:28       ` Peter Stuge
2011-09-27  6:44         ` Johannes Sixt [this message]
2011-09-27  9:49           ` Peter Stuge
2011-09-27  9:51             ` [PATCH] gitweb: Fix links to lines in blobs when javascript-actions are enabled Peter Stuge
2011-09-27 17:17               ` Junio C Hamano
2011-09-28  1:31                 ` Peter Stuge
2011-09-27 17:40             ` [PATCH] gitweb: Add js=1 before an URI fragment to fix line number links Junio C Hamano
2011-09-26 23:06 ` Junio C Hamano
2011-09-26 23:17   ` Peter Stuge
2011-09-26 23:19 ` Jakub Narebski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4E8170B3.8040205@viscovery.net \
    --to=j.sixt@viscovery.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peter@stuge.se \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).