You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Julian Foad ju...@btopenworld.com on 2003/01/27 02:43:17 UTC

Quotation marks needed around file names in error messages

I'm still new here and you might not think this is important, but ...

When I read this APR error from Subversion ...

subversion/libsvn_wc/status.c:718: (apr_err=155007)
svn: Path is not a working copy directory
svn: svn_wc_statuses: apr is not a working copy directory

... I thought, What path is not a w.c. dir?  What apr is not a w.c. 
dir?  I don't know what an apr is anyway.  Just tell me what file name 
is giving you a problem!

Later I discovered by other means that the name of the directory that it 
is trying to process is apr, and so I now understand that the third 
line is _mentioning_ the file name, rather than _using_ the word apr 
which could be part of its vocabulary.

The name should be quoted, e.g. the third line could look like this:

svn: svn_wc_statuses: apr is not a working copy directory

... in all such contexts.  This is important because it is common for 
files involved in error messages to have plain names (like file) or 
wierd names (like  ) that make the messages confusing otherwise.  I 
have come across similar confusion in other software, and a small amount 
of frustration makes a big impression.  Of course, after you have seen a 
given error once and learned to interpret it, it is easy to recognise it 
the next time.

- Julian


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: Quotation marks needed around file names in error messages

Posted by Karl Fogel kf...@newton.ch.collab.net.
Julian Foad julianfoad@btopenworld.com writes:
 No promises, but I might fit it in towards the end of the week.

Okay.  Note that David Kimdon (dwhedon) has already started this, in
revision 4599.  There's no reason to do it all in one patch, nor even
all by the same person, of course.  Just might want to coordinate w/
him.


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: Quotation marks needed around file names in error messages

Posted by David Kimdon <dw...@debian.org>.
On Tue, Jan 28, 2003 at 01:09:09AM +0000, Julian Foad wrote:
> Karl Fogel wrote:
> >Julian Foad <ju...@btopenworld.com> writes:
> >
> >>The name should be quoted, e.g. the third line could look like this:
> >>
> >>svn: svn_wc_statuses: "apr" is not a working copy directory
> >
> >
> >Julian, if you can do a search for svn_error_createf in the Subversion
> >sources and make the (presumably large-ish) patch for this, that would
> >be a big help.  Do you think you have the time?
> 
> No promises, but I might fit it in towards the end of the week.

I have a patch that I am running 'make check' on right now fixing
pretty much all of this class of difficult to parse error message.

-David

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: Quotation marks needed around file names in error messages

Posted by Julian Foad ju...@btopenworld.com.
Karl Fogel wrote:
 Julian Foad julianfoad@btopenworld.com writes:
 
The name should be quoted, e.g. the third line could look like this:

svn: svn_wc_statuses: apr is not a working copy directory
 
 
 Julian, if you can do a search for svn_error_createf in the Subversion
 sources and make the (presumably large-ish) patch for this, that would
 be a big help.  Do you think you have the time?

No promises, but I might fit it in towards the end of the week.

- Julian


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: Quotation marks needed around file names in error messages

Posted by Karl Fogel kf...@newton.ch.collab.net.
Julian Foad julianfoad@btopenworld.com writes:
 The name should be quoted, e.g. the third line could look like this:
 
 svn: svn_wc_statuses: apr is not a working copy directory
 
 ... in all such contexts.  This is important because it is common for
 files involved in error messages to have plain names (like file) or
 wierd names (like  ) that make the messages confusing otherwise.  I
 have come across similar confusion in other software, and a small
 amount of frustration makes a big impression.  Of course, after you
 have seen a given error once and learned to interpret it, it is easy
 to recognise it the next time.

You are *so* right.  We've been careless about this, and now it's a
problem.  I don't even think it much matters if they're single-quotes
or double-quotes, so long as there's something setting it off from the
rest of the message.

Julian, if you can do a search for svn_error_createf in the Subversion
sources and make the (presumably large-ish) patch for this, that would
be a big help.  Do you think you have the time?

Thanks,
-Karl

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: Quotation marks needed around file names in error messages

Posted by David Kimdon dw...@debian.org.
 wierd names (like  ) that make the messages confusing otherwise.  I 
 have come across similar confusion in other software, and a small amount 
 of frustration makes a big impression.  Of course, after you have seen a 
 given error once and learned to interpret it, it is easy to recognise it 
 the next time.

Thanks for the note, 6 of these fixed in rev 4599.

-David

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org