Re: svn commit: r12223 - in branches/locking/subversion: include libsvn_fs libsvn_fs_base libsvn_fs_fs libsvn_repos tests/libsvn_fs

["Peter N. Lundblad" <pe...@famlundblad.se>]

Docstring nits only.

On Tue, 7 Dec 2004 sussman@tigris.org wrote:

> Modified: branches/locking/subversion/include/svn_fs.h
> Url: http://svn.collab.net/viewcvs/svn/branches/locking/subversion/include/svn_fs.h?view=diff&rev=12223&p1=branches/locking/subversion/include/svn_fs.h&r1=12222&p2=branches/locking/subversion/include/svn_fs.h&r2=12223
> ==============================================================================
> --- branches/locking/subversion/include/svn_fs.h	(original)
> +++ branches/locking/subversion/include/svn_fs.h	Tue Dec  7 12:41:49 2004
> @@ -482,22 +482,59 @@
>  typedef struct svn_fs_txn_t svn_fs_txn_t;
>
>
> -/** Begin a new transaction on the filesystem @a fs, based on existing
> +/* @since New in 1.2  -- for use with svn_fs_begin_txn2 */
> +
> +/* Do on-the-fly out-of-dateness checks.  That is, an fs routine may
> +   throw error if a caller tries to edit an out-of-date item in the
> +   transaction.   ### NOTE:   NOT YET IMPLEMENTED.  */
> +#define SVN_FS_TXN_CHECK_OUT_OF_DATENESS         0x00001
> +
> +/* Do on-the-fly lock checks.  That is, an fs routine may throw error
> +   if a caller tries to edit a locked item without having rights to
> +   the lock. */
> +#define SVN_FS_TXN_CHECK_LOCKS                   0x00002
> +
Can't one have real doxygen comments for #defines? Or is there a special
reason not to have it?

> +
> +/** @since New in 1.2
> + *
> + * Begin a new transaction on the filesystem @a fs, based on existing
>   * revision @a rev.  Set @a *txn_p to a pointer to the new transaction.
>   * When committed, this transaction will create a new revision.
>   *
>   * Allocate the new transaction in @a pool; when @a pool is freed, the new
>   * transaction will be closed (neither committed nor aborted).
>   *
> + * @a flags determines transaction enforcement behaviors.  See the
> + * comments above SVN_FS_TXN_* constants above.
> + *
> + * If @a check_locks is TRUE, then do on-the-fly lock checks.  That
> + * is, various fs routines may throw an error the instant a caller
> + * tries to modify something in the transaction that is locked (or
> + * contains locks) which the caller has no right to use.

Left-over from before you changed to flags?

> +
> +/** @deprecated Provided for backward compatibility with the pre-1.2 APIs.

I usually write "... with the 1.1 API."

> + *
> + * Same as svn_fs_begin_txn2(), but with @a check_ood and @a
> + * check_locks arguments both set to FALSE.
> + *
Pre-flags era here too?

//Peter

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