This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 20385 - Version Control API
Summary: Version Control API
Status: RESOLVED WONTFIX
Alias: None
Product: obsolete
Classification: Unclassified
Component: vcscore (show other bugs)
Version: 3.x
Hardware: All All
: P1 blocker (vote)
Assignee: Martin Entlicher
URL: http://vcscore.netbeans.org/doc/VCSAP...
Keywords: API
Depends on: 20627 28119 28120
Blocks: 20383 21316 26768
  Show dependency tree
 
Reported: 2002-02-08 18:57 UTC by Martin Entlicher
Modified: 2005-12-02 11:57 UTC (History)
3 users (show)

See Also:
Issue Type: TASK
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Entlicher 2002-02-08 18:57:22 UTC
This issue was created in order to discuss the design of VCS API.

The vcscore module is currently designed as a library of various VCS related
things useful for modules providing VCS functionality to NetBeans IDE.
It has no functionality visible to users by itself. The code in vcscore module
has to evolve in consistence with the modules, that depends on it, while there
is no easy way to know (besides looking into the code) which modules uses which
functionality.

This is why Version Control API is proposed, to have a well defined interface
for other modules using VCS functionality or providing their own.

The current version of the proposal is at
http://vcscore.netbeans.org/doc/VCSAPI.html
Comment 1 Martin Entlicher 2002-02-19 15:41:07 UTC
I was able to significantly reduce the number of classes in the APIs.
I've decided to remove (among other things) the versioning FS, since
it's not clear whether this feature will be kept in current form for
future releases.

Please look at http://vcscore.netbeans.org/doc/VCSAPI.html, there is
some more UML and link to Javadoc. You'll also find a brief
description of the APIs there.

Any comments/suggestions are welcomed.
Comment 2 Jaroslav Tulach 2002-02-21 06:30:12 UTC
I am trying to understand the API, but what I am missing is sample
usage. Would it be possible to write vcscore/test/unit or test/sample
that would demonstrate the proposed usage of the API? We would benefit
from more accurate definition and tests of how the api should be used.
Comment 3 Martin Entlicher 2002-02-22 14:25:26 UTC
Sample usage added to the document.
Providers moved to SPI, new class introduced - VcsManager, that
delegates the work to SPI and API implementation.
VcsManager should be used by API users,
providers by API implementators.
Comments are welcomed.
Comment 4 Martin Entlicher 2002-05-16 11:22:11 UTC
Changing Target Milestone to 4.0. The APIs are almost finished at this
time, but there are no tests and refrence implementation, thus it's
not ready for 3.4 timeframe.
Comment 5 Martin Entlicher 2002-09-09 14:07:18 UTC
This is a must-have task for 4.0, it's needed by projects (issue
#26768) => changing priority to P1.

Comment 6 Martin Entlicher 2002-09-18 10:21:09 UTC
Adding PROJECTS keyword. Projects depend on this being resolved.
Comment 7 Martin Entlicher 2002-11-01 16:43:27 UTC
The new VCS APIs were just merged into the main trunk.
I'm going to prepare apichanges document and update the final javadoc.
Comment 8 Jiri Kovalsky 2002-11-08 10:45:57 UTC
It has really been integrated, since 10 new bugs occured. :-) Verified
in development build #200211080100 of NetBeans 4.0.
Comment 9 Martin Entlicher 2002-11-08 11:42:08 UTC
> It has really been integrated, since 10 new bugs occured. :-)

This is a nice assumption :-))) But unfortunately true :-((( The core
functionality was reimplemented.
I hope that the APIs will be helpfull for the tests as well.
Comment 10 Jaroslav Tulach 2002-11-13 10:09:43 UTC
Sorry for reopening, but there are things that still should be done.
The javadoc for the API is insufficient as it does not document nearly
anything (how to use the API, which dependency must be added to my
module in order to use that api, etc.) and also Martin promised to
write unit tests, which still are not present. I am sorry, but this is
not a state when one can claim that it has finished an api.
Comment 11 Martin Entlicher 2002-11-13 10:13:35 UTC
O.K. I apology that this is not ready yet.
I'll do that after end of November (developer ready 1 of projects).
Comment 12 Tomas Pavek 2003-04-04 10:07:07 UTC
This should be completed till "Projects Ready" at the latest.
Comment 13 Martin Entlicher 2003-11-20 13:32:23 UTC
Removing PROJECTS keyword. This is not projects-related at all.
Comment 14 _ alexlamsl 2005-12-01 15:41:28 UTC
has this issue been worked on / is it obsolete as of NB5?
Comment 15 _ alexlamsl 2005-12-02 11:57:54 UTC
probably out-dated - closing as won't fix