VCS plugin docs?

Well, I can tell you that most of the methods, such as moveRenameAndCheckInFile,
are called during the Check In Project action. This essentially means commit
local changes to the source control system. Whether that is literally "check in"
or some other operation is up to you, as long as the local changes are committed.



Marc Palmer wrote:

Hi,

Are there any javadocs that actually tell you clearly what the contract
is for implements of AbstractVcs?

I've started work on a plugin for the free SourceJammer VCS system
(www.sourcejammer.org ? a nice SOAP-based VCS) but I can't tell really
what IDEA wants me to do sometimes for the implementation of these
methods.

Yes, I've looked at the StarTeam VCS source, but unless you know what
StarTeam actually does itself, you can't tell what it is IDEA expects the
plugin to do when it calls some of the methods.

As a result of this I don't fully understand the discussion of the VCS
problems on www.intellij.org ? but I have a feeling that SourceJammer
will not be compatible with full IDEA integration either.

I don't understand why there is a moveRenameAndCheckInFile ? why is a
check in required? Some CVS may not need this ? what are the semantics
from IDEA's point of view?

Kind regards,
Marc
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ W<A> ~~~~~
(o) Wangjammer5 (Marc Palmer)
( ) Wangjammer7

www.wangjammers.org = Java Consultants (Web|Smartcards|Crypto)

--

Erb

==============================================================
"Most of you are familiar with the virtues of a programmer.
There are three, of course: laziness, impatience, and hubris."
- Larry Wall
==============================================================

There is an SCR filed for that:
http://www.intellij.net/tracker/idea/viewSCR?publicId=4446

Apart from a javadoc documentation, I would really appreciate a white paper from IntelliJ team, where the complete workflow for external VCS integration is explained. This is a very obscure part of the OpenAPI and in order to implement something based on it, a good understanding is absolutely required.

Lack of a good documentation is a real weakness of the OpenAPI. I thought that after the eventual Ariadna release some effort will be put into clean up and documentation of the Open API. Sadly enough, this did not happen.

Another thought is that if IntelliJ team repackaged CVS and Sourcesafe integration packages as plugins (with an open source), that would:
- greatly help to iron out OpenAPI;
- help plugin writers better understand the API contracts;
- decompose the IDE.