Overview (Versioning)

Versioning
Package	Description
org.netbeans.modules.versioning.spi

Versioning SPI module enables Source Code Management (SCM or Versioning) modules to fully integrate into the IDE workflow. Mostly it is a facade over existing friend APIs (masterfs). Registration: SCM module extends VersioningSystem and registers itself via default Lookup: it puts "org.netbeans.modules.versioning.spi.VersioningSystem" file in its META-INF/services folder. VersioningSPI Enables Source Code Management (SCM or Versioning) modules to fully integrate into the IDE workflow.

What is New (see all changes)?

Nov 16 '12 Support ContextAwareActions
make it possible for Versioning Systems to fire visibility changes for a list of files instead of one unspecific change event.
Apr 12 '12 Support ContextAwareActions
Ensure that ContextAwareAction-s provided via VCSHistoryProvider.HistoryEntry.getActions() are created with a context containing the selected nodes in a files editor history tab. Those nodes than will have the relevant HistoryEntry and files in their lookup.
Apr 12 '12 Added VCSHistoryProvider.HistoryEntry.getParent()
New method VCSHistoryProvider.HistoryEntry.getParent() to provide the VCSHistoryProvider.HistoryEntry representing the parent of the given revision.
Jan 30 '12 Added VCSHistoryProvider
New type VCSHistoryProvider makes it possible for versionig systems to provide information about a files history which is then used in that files editor history tab.
Jul 19 '11 isExcluded() added to VersioningSupport
Method isExcluded states that a given folder is excluded from version control completely. All version control systems should respect the return value and consider such folders to be unversioned.

Use Cases

Main and Popup Menu usecases come from the UI spec available here: Versioning UI spec

Main Menu Itegration

All installed SCM systems must cooperate while constructing popup and main menus, see UI spec.

Popup Menu Itegration

All installed SCM systems must cooperate while constructing popup and main menus, see UI spec.

Coloring and Badging (annotations)

An SCM system needs a way to annotate labels and icons in the IDE.

Automated Versioning

To enable automated versioning (adds, removes, moves, delets), a SCM system needs to integrate at the lowest level into the IDE's filesystem layer. Refactoring is the most critical filesystem client here.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
VersioningSPI	Exported	Under Development	Enables Source Code Management (SCM or Versioning) modules to fully integrate into the IDE workflow.

Group of property interfaces

Interface Name	In/Out	Stability	Specified in What Document?
versioning.netbeans.user.versioned	Exported	Private	NetBeans userdir is by default excluded from version control for performance reason. This can be overridden by setting the property to `true`.

Implementation Details

Where are the sources for the module?

The sources for the module are in the NetBeans Mercurial repositories.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

No special requirements here.

Read more about the implementation in the answers to architecture questions.

VersioningUnder Development