You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Branko Čibej <br...@xbc.nu> on 2004/05/12 02:27:47 UTC
Marking 1.1 API changes
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.
-- Brane
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: Marking 1.1 API changes
Posted by Branko Čibej <br...@xbc.nu>.
kfogel@collab.net wrote:
>Branko Čibej <br...@xbc.nu> writes:
>
>
>>> @since New in 1.1.
>>>
>>>
>>Do we say "New in version 1.1" or just "New in 1.1"? I vote for the
>>first variant, but in any case please decide before my next commit. :-)
>>
>>
>
>I already committed with the second. Don't feel strongly about it; if
>you want the first, we can change it.
>
>
Yes, I noticed. Gor a bunch of conflicts. :-)
I changed my additions to match yours, no problem.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: Marking 1.1 API changes
Posted by kf...@collab.net.
Branko Čibej <br...@xbc.nu> writes:
> > @since New in 1.1.
>
> Do we say "New in version 1.1" or just "New in 1.1"? I vote for the
> first variant, but in any case please decide before my next commit. :-)
I already committed with the second. Don't feel strongly about it; if
you want the first, we can change it.
-K
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: Marking 1.1 API changes
Posted by Branko Čibej <br...@xbc.nu>.
kfogel@collab.net wrote:
>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.
>
>
Actually they would all be new in 1.1, except that these would also be
immediately deprecated. :-)
>For others, it will just say
>
> @since New in 1.1.
>
>
Do we say "New in version 1.1" or just "New in 1.1"? I vote for the
first variant, but in any case please decide before my next commit. :-)
-- Brane
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: Marking 1.1 API changes
Posted by kf...@collab.net.
"Erik Huelsmann" <e....@gmx.net> writes:
> > Well, that's not quite right. They should all say "New in 1.1", but
> > the *2 APIs will say "API changed in 2.0" when 2.0 comes out.
>
> So we won't be renaming them to their (original) non-2 names then?
No, we will, that's why we want to say something about how the API
changed since 1.0, instead of the symbol itself being new in 2.0.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: Marking 1.1 API changes
Posted by Erik Huelsmann <e....@gmx.net>.
> kfogel@collab.net writes:
> > 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.
>
> Well, that's not quite right. They should all say "New in 1.1", but
> the *2 APIs will say "API changed in 2.0" when 2.0 comes out.
So we won't be renaming them to their (original) non-2 names then?
bye,
Erik.
--
"Sie haben neue Mails!" - Die GMX Toolbar informiert Sie beim Surfen!
Jetzt aktivieren unter http://www.gmx.net/info
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: Marking 1.1 API changes
Posted by kf...@collab.net.
kfogel@collab.net writes:
> 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.
Well, that's not quite right. They should all say "New in 1.1", but
the *2 APIs will say "API changed in 2.0" when 2.0 comes out.
-K
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: Marking 1.1 API changes
Posted by kf...@collab.net.
Branko Čibej <br...@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