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

Re: Marking 1.1 API changes

From: <kfogel_at_collab.net>
Date: 2004-05-12 19:47:28 CEST

Branko ─îibej <brane@xbc.nu> writes:
> All ye who are making API changes in 1.1-dev,
>
> I suggest we use doxygen markup for all new bits in the API:
>
> @since New in version 1.1.
>
> and for all the bits that are scheduled to go away in 2.0:
>
> @deprecated Provided for backward compatibility with the 1.0 API.
>
> There are already a number of @deprecated tags in the source, but no
> @since tags. I've fond those to be very useful, e.g., in the Python
> documentation.

Good idea. Below is a list of (I think) all the new APIs. I'll add
@since tags to them. For 'svn_foo_bar2' functions, the @since text
will say

   @since API changed in 1.1.

For others, it will just say

   @since New in 1.1.

Here's the list:

   svn_repos_dump_fs2()
   svn_repos_parse_dumpstream2()
   svn_repos_get_fs_build_parser2()
   svn_repos_parse_fns2_t

   SVN_FS_CONFIG_FS_TYPE
   SVN_FS_TYPE_BDB
   SVN_FS_TYPE_FSFS
   svn_fs_create()
   svn_fs_open()
   svn_fs_path()
   svn_fs_delete()
   svn_fs_hotcopy()

   svn_wc_adm_open2()
   svn_wc_adm_probe_open2()
   svn_wc_adm_probe_try2()

   svn_stream_copy()

   SVN_REPOS_DUMPFILE_PROP_DELTA
   SVN_REPOS_DUMPFILE_TEXT_DELTA

   SVN_ERR_CLIENT_UNRELATED_RESOURCES
   SVN_ERR_FS_UNKNOWN_FS_TYPE
   SVN_ERR_VERSION_MISMATCH

   svn_txdelta_target_push()
   svn_txdelta_read_svndiff_window()
   svn_txdelta_skip_svndiff_windowe()

   svn_io_file_flush_to_disk()

   svn_version_t
   SVN_VER_GEN_PROTO
   SVN_VER_GEN_IMPL
   svn_ver_compatible()
   svn_ver_callback_compatible()
   SVN_VER_COMPATIBLE
   SVN_VER_CALLBACK_COMPATIBLE

   svn_client_version()
   svn_subr_version()

-Karl

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Wed May 12 21:03:11 2004

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

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.