All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Jari Aalto <jari.aalto@cante.net>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Improve error message: not a valid branch name
Date: Sun, 26 Aug 2007 14:26:28 -0700	[thread overview]
Message-ID: <7vd4xang1n.fsf@gitster.siamese.dyndns.org> (raw)
In-Reply-To: y7fyfh7x.fsf@cante.net

Jari Aalto <jari.aalto@cante.net> writes:

> (create_branch): Extend die message from 'is not a valid branch name'
> to '...(see git-check-ref-format)'.

I think you meant to say "see git-check-ref-format(1)" as you
meant the manual page.

I am a bit torn on this.  git-check-ref-format.1 is where we
currently _happen_ to describe what valid refnames should look
like, but it could be argued that it is a bug in the manual.

Two possible improvements that are mutually incompatible would
be:

 - refactor that part of the manual to be included in the pages
   for any and all commands that can take refname from the user;
   this is inpractical as almost all command would be affected.

 - move that to more central place, say git(7), and everybody
   refer to that page;

I'd personally prefer the latter, as "naming things" is such a
central thing for the use of the system (this applies to the
description of "SHA-1 expression" that we curently have in
git-rev-parse(1) as well) and it is better for users to have
understanding of such fundamental syntaxes and concepts before
even using any individual commands.

  reply	other threads:[~2007-08-26 21:26 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-08-26 15:28 [PATCH] Improve error message: not a valid branch name Jari Aalto
2007-08-26 21:26 ` Junio C Hamano [this message]
2007-08-26 22:09   ` Jari Aalto
2007-08-26 22:25     ` J. Bruce Fields

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=7vd4xang1n.fsf@gitster.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jari.aalto@cante.net \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.