Concept : Understanding Check In and Check Out

Page Status: Beta
Jump to: navigation, search

Back to Concepts and HOW TOs

Contents

[edit] Description

When you create or work on a solution in Bungee Builder, you are working in your own workspace—every user has a unique workspace. Users that share a DesignGroup also share a common Depot, and Production space (for an overview of these principals see Intro to Bungee Concepts 1 on the Screencasts page).

New solutions exist only in your local workspace. To share your solution with members of your DesignGroup, you must check in your solution, which copies it to the Depot. Once checked in, anyone in the DesignGroup can check out the solution (or projects or classes), make changes, and check the changed objects back in. Also, projects must be checked into the Depot before they can be posted, shared, or deployed.

A symbol to the right of an object’s icon indicates the check-in/check-out status of the object:

  • Green plus sign: The object is not checked in (this is the status of an object when you first create it).
  • Green check mark: The object is checked out by you.
  • Red check mark: The object is checked out by someone else in your DesignGroup. You can mouse over the object and the tooltip will show who has the object checked out.
  • Yellow triangle: The object in your workspace is out of sync with the copy in the Depot (another DesignGroup member checked in a change).
  • No symbol: The copy of the object in your workspace matches the copy in the Depot.

[edit] Check In and Check Out Summary

  • Only container objects, such as solutions, projects, and classes, can be checked out.
  • In order to create a new project in a solution that’s checked in—you must first check out the solution.
  • In order to add a class, interface, or datasource to a project that’s checked in—you must first check out the project.
  • In order to add form, field, function, etc., to a class that’s checked in—you must first check out the class.
  • Any new container objects created in the workspace are automatically marked with a green plus sign (not checked in).
  • An object can be checked out by only one user at a time.
  • Check out is not recursive—only the object being checked out is checked out.
  • Check in is recursive—the object and all its children are checked in.

Note You can make changes without checking out the object. Then, if you check out and check in the object, the change is written to the depot (when you check out an object, the object in your workspace is not overwritten).

[edit] Sync

When you Sync an object, you’re copying an object from the Depot to your local workspace. Objects become out-of-sync when another member of your DesignGroup checks in changes to an object. When several people are working on a project simultaneously, make sure you’re working on the most up-to-date version by Syncing your project before making changes.

[edit] Recursive Sync

The Recursive Sync menu option is displayed in the place of the Sync menu option when you right-click a container such as a solution or project. This is meant to indicate that all members of the solution or project get synchronized with the contents of the Depot when you click the menu option.

Note Recursive Sync does not affect objects that are currently checked out.

[edit] Sync Summary

  • The item must not be checked out.
  • An out of sync object cannot be checked out.

    Caution If you make changes to an object, but don't check the object out of the Depot first, and you then Sync the object, all changes you made are overwritten by the copy of the object that exists in the Depot.

[edit] Revert

Use Revert to completely undo any changes you made to an object. When you Revert, an object is copied from the Depot to your local workspace, overwriting the local copy. Any changes you have made to the object are lost when Revert.

[edit] Revert Summary

  • You must have the object checked out.
  • You can Revert any object.
  • Revert is not recursive.

    Caution If you check an object out of the Depot, make changes, and then Revert the object, your changes will be overwritten by the copy in the Depot.

[edit] Mark For Delete Indicator

If you delete an object in the Solution Explorer (in a project that has been checked in), an X is added to the end of the object's name. For example: 

When you check in your project, the object you so marked gets deleted.

[edit] Undeleting a Project or Class

If you have accidently marked a class or a project for deletion, but have not yet checked in, you can "undelete" a
class
or project using the Undelete button at the far right of the the toolbar at the top of the Solution Explorer. If you delete a solution from the depot, there is no undo, but if you choose to delete only from your workspace, the depot copy is still available for you to open in your workspace again.

[edit] See Also

Using Check In and Check Out
Posting, Sharing, and Deploying

[edit] Tags

    Copyright © 2005 - 2008 Bungee Labs. All rights reserved.