Git Virtual File System
C# C++ Other
Latest commit fe155ee Feb 9, 2017 @sanoursa sanoursa committed on GitHub Merge pull request #19 from bbodenmiller/patch-1
improve readme formatting

Readme.md

GVFS

What is GVFS?

GVFS stands for Git Virtual File System. GVFS virtualizes the file system beneath your git repo so that git and all tools see a fully hydrated repo, but GVFS only downloads objects as they are needed. GVFS also manages git's sparse-checkout to ensure that git operations like status, checkout, etc., can be as quick as possible.

GVFS is still in progress, but it is available here for anyone to try out. Feel free to send us feedback, bug reports, suggestions, and pull requests!

Building GVFS

  • Install Visual Studio 2015 Community Edition or higher, and include the C++ language (https://www.visualstudio.com/downloads/)
  • Install InnoSetup 5.5.9 or later (http://www.jrsoftware.org/isdl.php) to its default location (or you'll have to change the path in GVFS.csproj post-build step to match)
  • Create a folder to clone into, e.g. C:\Repos\GVFS
  • Clone this repo into the src subfolder, e.g. C:\Repos\GVFS\src
  • Open src\GVFS.sln in Visual Studio
  • Build GVFS.sln

Testing GVFS

  • GVFS requires Windows 10 Anniversary Update or later
  • Enable test signed drivers
    • IMPORTANT: do not do this on a production machine. This is for evaluation only.
    • First, suspend BitLocker, if it is currently enabled
      • Go to Control Panel > System and Security > BitLocker Drive Encryption
      • For your OS drive, select "Suspend Protection" (This only suspends BitLocker until the next reboot. It does not disable BitLocker protection.)
    • In an elevated command prompt, type bcdedit -set TESTSIGNING ON
    • Reboot to apply the change, and this will also re-enable BitLocker
  • Install GVFS-enabled Git for Windows (2.11.0.gvfs.1.3 or later) from https://github.com/Microsoft/git/releases/tag/gvfs.preview
    • This build behaves the same as Git for Windows 2.11.0.windows except if the config value core.gvfs is set to true.
  • Install GVFS from your build output
    • If you built it as described above, the installer can be found at C:\Repos\GVFS\BuildOutput\GVFS\bin\x64\[Debug|Release]\Setup\SetupGVFS.exe
  • GVFS will work with any git service that supports the GVFS protocol. For now, that means you'll need to create a repo in Team Services (https://www.visualstudio.com/team-services/), and push some contents to it. There are two constraints:
    • Your repo must not enable any clean/smudge filters
    • Your repo must have a .gitattributes file in the root that includes the line * -text
  • gvfs clone <URL of repo you just created>
  • cd <root>\src
  • Run git commands as you normally would
  • gvfs unmount when done

Licenses

The GVFS source code in this repo is available under the MIT license. See License.md.

GVFS relies on the GvFlt filter driver, available as a prerelease NuGet package with its own license.