[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: Error message conventions

From: Branko Čibej <brane_at_xbc.nu>
Date: 2003-11-24 01:45:26 CET

Erik Huelsmann wrote:

>+Error message conventions
>+=========================
>+
>+For error messages the following conventions apply:
>+
>+ * Provide specific error messages only when there is information
>+ to add to the general error message found in
>+ subversion/include/svn_error_codes.h
>
>
If we enforce this, then we must allow parameter placeholders in those
messages. Otherwise people can't both use svn_error_createf and obey
this guideline.

>+ * Keep messages below 70 characters.
>
>
This is hard to do in practice, once you take interpolated file names
into account. But I agree in principle.

>+ * When including path or filenames in the error string, be sure
>+ to quote them. (i.e. "Can't find '/path/to/repos/userfile'")
>
>
And convert the file names with svn_path_local_style before
interpolating them into the error message text.

-- 
Brane Čibej   <brane_at_xbc.nu>   http://www.xbc.nu/brane/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Mon Nov 24 01:43:55 2003

This is an archived mail posted to the Subversion Dev mailing list.