forks/geef
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Write a few docs

Browse Source
This commit is contained in:
Carlos Martín Nieto
2013-03-31 23:17:51 +02:00
parent 2dcd701c53
commit c2d1acbbe6
3 changed files with 17 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/geef.erl
View File

@@ -1,3 +1,6 @@
%%% @private
%%% NIF functions, not to be used directly.
-module(geef). -module(geef).
-export([hex_to_raw/1, reference_list/1, -export([hex_to_raw/1, reference_list/1,
reference_to_id/2, reference_glob/2, reference_lookup/2, reference_resolve/1, reference_to_id/2, reference_glob/2, reference_lookup/2, reference_resolve/1,

6
src/geef_oid.erl
View File

@@ -1,3 +1,4 @@
%%% @doc Dealing with object names
-module(geef_oid). -module(geef_oid).
-ifdef(TEST). -ifdef(TEST).
@@ -8,12 +9,13 @@
-export([parse/1, fmt/1]). -export([parse/1, fmt/1]).
%% @doc Get the hex-encoded hash
-spec fmt(oid()) -> binary(). -spec fmt(oid()) -> binary().
fmt(#oid{oid=Oid}) -> fmt(#oid{oid=Oid}) ->
geef:oid_fmt(Oid). geef:oid_fmt(Oid).
%% @doc Parse an iolist as a hash
-spec parse(binary()) -> oid(). -spec parse(iolist()) -> oid().
parse(Sha) -> parse(Sha) ->
Oid = geef:oid_parse(Sha), Oid = geef:oid_parse(Sha),
#oid{oid=Oid}. #oid{oid=Oid}.

10
src/geef_repo.erl
View File

@@ -4,14 +4,18 @@
-include("geef_records.hrl"). -include("geef_records.hrl").
%% @doc The repository's git-dir path
-spec path(repo()) -> binary(). -spec path(repo()) -> binary().
path(#repo{handle=Handle}) -> path(#repo{handle=Handle}) ->
geef:repository_get_path(Handle). geef:repository_get_path(Handle).
%% @doc The repository's worktree path
-spec workdir(repo()) -> binary(). -spec workdir(repo()) -> binary().
workdir(#repo{handle=Handle}) -> workdir(#repo{handle=Handle}) ->
geef:repository_get_workdir(Handle). geef:repository_get_workdir(Handle).
%% @doc The repository's current object database. This encompasses all
%% the configured backends.
-spec odb(repo()) -> {ok, odb} | {error, term}. -spec odb(repo()) -> {ok, odb} | {error, term}.
odb(#repo{handle=Handle}) -> odb(#repo{handle=Handle}) ->
case geef:repository_get_odb(Handle) of case geef:repository_get_odb(Handle) of
@@ -21,18 +25,23 @@ odb(#repo{handle=Handle}) ->
Other Other
end. end.
%% @doc Whether the repository is bare
-spec is_bare(repo()) -> boolean(). -spec is_bare(repo()) -> boolean().
is_bare(#repo{handle=Handle}) -> is_bare(#repo{handle=Handle}) ->
geef:repository_is_bare(Handle). geef:repository_is_bare(Handle).
%% @doc List of references in the repository.
-spec references(repo()) -> [binary()]. -spec references(repo()) -> [binary()].
references(#repo{handle=Handle}) -> references(#repo{handle=Handle}) ->
geef:reference_list(Handle). geef:reference_list(Handle).
%% @doc Discover a repository's path from a path contained inside it
-spec discover(iolist()) -> {ok, binary()} | error | {error, term()}. -spec discover(iolist()) -> {ok, binary()} | error | {error, term()}.
discover(Path) -> discover(Path) ->
geef:repository_discover(Path). geef:repository_discover(Path).
%% @doc Open an existing repository. Path must point to the git-dir or
%% worktree
-spec open(iolist()) -> {ok, repo()} | {error, term()}. -spec open(iolist()) -> {ok, repo()} | {error, term()}.
open(Path) -> open(Path) ->
case geef:repository_open(Path) of case geef:repository_open(Path) of
@@ -42,6 +51,7 @@ open(Path) ->
Other Other
end. end.
%% @doc Initialize a new repository
-spec init(iolist(), boolean()) -> {ok, repo()} | {error, term()}. -spec init(iolist(), boolean()) -> {ok, repo()} | {error, term()}.
init(Path, Bare) -> init(Path, Bare) ->
case geef:repository_init(Path, Bare) of case geef:repository_init(Path, Bare) of