BitKeeper Windows Explorer Shell Extension
Table of Contents
- Shellx Icon Overlays
- Interacting with the Shellx Menus
- Shellx Menu Options
- Screenshots
Introduction
The BitKeeper shell extension (shellx) is provided as a means for Windows
users to integrate with the BitKeeper environment in a way that is familiar
to them through Windows Explorer. The shellx allows you to browse and
control your BitKeeper repositories through the standard Windows Explorer
interface by providing visual feedback and context-sensitive menu
integration for interaction with your repositories.
Shellx Icon Overlays
When you are browsing inside of a BitKeeper repository, the icons that
Windows Explorer provides will be augmented by overlays from the shellx
that give you information about the state of those files within the
repository. This lets you know, at a glance, what state your files are in
and what you can or need to do with them. The shellx recognizes files in
the following states:
Editable
Files that are part of the current repository and checked out in
edit mode are shown with a green check mark. This means that the
file is editable but has no changes.
Read-Only
Files that are checked out in read-only mode will have a green circle
with a line through it to signify that the file is part of the
repository, but because it is read-only, no action can be taken on it.
Modified
Files that have been changed will appear with a red circle.
Ignored
Files which are being ignored by BitKeeper will appear with a grey
circle.
Extra
Any file which is not part of the repository and is not already being
ignored is considered to be extra by BitKeeper. Extra files appear
with a blue question mark.
Interacting with the Shellx Menus
Right-clicking in Windows Explorer will bring up your context menu
where you will see a BitKeeper sub-menu that changes dynamically based on
the state of what you have selected. The shellx has 4 "states" that it
considers when the menus are created:
- Not in a Repository
When you right-click on or inside a folder which is not a BitKeeper
repository, you get a small set of menu options that allow you to
clone a new repository in the current location or create a new
repository using the setup wizard.
- In a Repository with Files Selected
Right-clicking on a selection of files will bring up a set of menu
options that allow you to operate on the files in various ways
depending on the state of the files selected.
For example, selecting files which are not part of the current
repository (extra files) will give you the option to add the selected
files to the repository. Selecting files that are modified gives you
the option to revert the changes in those files back to their previous,
unmodified state.
- In a Repository with Folders Selected
Right-clicking on a selection of folders will add a set of menu options
that lets you operate on your repository recursively. This lets you
checkout files for an entire folder structure in one command.
- In a Repository with the Background of the Current Folder Selected
Right-clicking on the background of a folder will give you means options
that let you checkout all of the files in the current folder only.
Shellx Menu Options
The menu options available when you open the context menu change based
on the files and folders you have selected. The following menu items
are available:
BK Edit Files...
Shown when clicking the background of a folder or when selected
files are read-only.
Checkout files in the current folder so that they are editable.
BK Checkin Tool...
Shown when clicking inside of a repository.
Launch the BitKeeper checkin tool. The checkin tool will scan your
repository for files that have changed and allow you to comment and
check them in.
BK Diff File...
Shown when a single, modified file is selected.
Launch the BitKeeper difftool on the selected file.
BK Diff Directory...
Shown when clicking on the background of a folder with modified files.
Launch the BitKeeper difftool and show the differences in modified
files in the current repository.
BitKeeper
Checkout Files Read-Only...
Shown when clicking on the background of a folder.
Checkout files in the current folder in a read-only state.
Checkout Files Read-Write...
Shown when clicking on the background of a folder.
Checkout files in the current folder in a read-write or
editable state.
Checkout Files Read-Only (recursive)...
Shown when selecting a single folder.
Checkout all files recursively in a read-only state starting in the
selected folder and moving down through all directories that are part
of the current repository.
Checkout Files Read-Write (recursive)...
Shown when selecting a single folder.
Checkout all files recursively in an editable state starting in the
selected folder and moving down through all directories that are part
of the current repository.
Revision Tool...
Shown when selecting inside of a repository.
Launch the BitKeeper revtool to show the revision history of the current
repository. If a single file is selected, the revision tool will show
the revision history for only the selected file instead of the entire
repository.
View Local Changesets...
Shown when selecting a folder or the background of a folder.
Show any changesets which are committed and ready to be pushed to the
parent repository.
View Remote Changesets...
Shown when selecting a folder or the background of a folder.
Show any changesets in the parent repository that have been committed
and need to be pulled into the current repository.
Push Changesets to Parent
Shown when selecting a folder or the background of a folder.
Push any local changesets to the parent repository.
Pull Changesets from Parent
Shown when selecting a folder or the background of a folder.
Pull any new changesets from the parent repository into the local
repository.
Add Files
Shown when selecting one or more files that are not part of the
repository.
Add the selected files that are not already part of the repository to
the current repository.
Delete Files
Shown when selecting unmodified files that are part of the repository.
Delete the selected files from the repository.
Revert Changes
Shown when selecting modified files.
Revert any changed files back to their unchanged state.
Clean Unmodified Files
Shown when selecting files that are part of the repository.
Remove any unmodified files (bk clean).
Clone a Repository...
Shown when selecting a folder or the background of a folder.
Clone a new repository into the current folder.
Create a Repository Here...
Shown when selecting a folder that is not part of a repository.
Create a new repository in the current folder.
Open Command Prompt...
Always shown.
Open a command prompt window in the current folder.
Help...
Always shown.
Display the BitKeeper helptool.
About...
Always shown.
Display version information about the current shellx.
Screenshots
Shellx Icon Overlays
|
Selecting the folder background when not in a repository
|
Selecting an extra file
|
Selecting a modified file
|
Selecting a readonly file
|
Selecting the folder background
|