NAME

Git::Database::Tutorial - Learn how to use Git::Database

VERSION

version 0.002

SYNOPSIS

use Git::Database;

# do cool stuff with Git, using the following advice
# and the Perl Git wrapper of your choice

GLOSSARY

repository

The local Git repository, as managed by git.

backend

A class doing the Git::Database::Role::Backend role. The Git::Database module acts as a frontend that returns a backend object.

It manages all interactions with the Git repository, via its store. A backend instance is always connected to a store instance.

The backend interface is split across several roles, each requiring one or more access methods to be defined. The roles are: Git::Database::Role::Backend (this is the minimum required role that a class must do to be considered a backend), Git::Database::Role::ObjectReader, Git::Database::Role::ObjectWriter, Git::Database::Role::RefReader and Git::Database::Role::RefWriter.

Git::Database::Backend::None is a special backend class that is not connected to a store. The only supported method is hash_object.

store

The Perl Git wrapper that reads and write the data from and to the repository.

A store instance is always connected to an actual Git repository.

The only currently supported store is Git::Repository. Several branches exist in the development repository to add support for other Git wrappers. Patches welcome!

object

An object from the Git object database. Represented in Perl by the Git::Database::Object::Blob, Git::Database::Object::Tree, Git::Database::Object::Commit and Git::Database::Object::Tag classes.

ref

A reference (tag or branch) in the Git repository.

AUTHOR

Philippe Bruhat (BooK) <book@cpan.org>.

COPYRIGHT

Copyright 2016 Philippe Bruhat (BooK), all rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.