Re: [PATCH] with log Re: svn_auth_cred_simple_t crash

I agree that we should not explicity document that pointers need to be
non-null, except as a clarification (probably parenthesised to indicate that
this is a clarification).

Martin Hauner wrote:
>
> Index: subversion/include/svn_auth.h
> ===================================================================
> --- subversion/include/svn_auth.h (revision 13396)
> +++ subversion/include/svn_auth.h (working copy)
> @@ -170,9 +170,11 @@
> /** @c SVN_AUTH_CRED_SIMPLE credentials. */
> typedef struct svn_auth_cred_simple_t
> {
> - /** Username */
> + /** Username. Expected to be non zero. Use the empty string (ie. "") for
> + * and empty or unspecified username.
> + */

If the user name is indeed optional, the comment should say so, and an
appropriate comment would be:

   /** User name. May be the empty string to indicate an unknown user. */

or

   /** User name. May be the empty string (not NULL) to indicate an unknown
user. */

> const char *username;
> - /** Password */
> + /** Password. Expected to be non zero. See above. */
> const char *password;

The phrase "See above" is not specific enough to be used in a documentation
comment. (There is lots of text above that point, and any or all of it may be
moved or changed in future.)

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Tue Mar 15 03:30:04 2005