libgit-thin: Introduces git_commit_to_str()
[git/libgit-gsoc.git] / libgit-thin / TODO
blob29acb1c5f52cfe0fcf7bc4acac117a1ff14ab9e1
1 General
2 -------
4 o Add pygit's skeleton
5 o Better integrate with the toplevel Makefile, so there's less duplication
6   and more of the toplevel's configuration (like guessing GIT_LIBS) can be
7   inherited
9 Documentation
10 -------------
12 o Currently, libgit-thin's generated documentation is very low-level. We're
13   showing which files we have and their includes. Instead, we should only
14   show a function listing sorted by subject (eg, commit, rev listing etc).
15 o Into each subject, functions should be sorted too (eg, __git_commit_free()
16   right before git_commit_free()). Currently they're sorted in alphabetical
17   order
19 pygit
20 -----
22 o Test-suite
23 o Implement missing commit date functions
24 o Not sure whether PyGitError is the right thing to do
25 o Some revlist options could be attributes, not methods (eg, show_merges
26   and max_count)
27 o Pygit types should be useful as base classes
28 o Commit type's compare is wrong currently
29 o Integrate the build in the main one
31 tests
32 -----
34 o See tests/MISSING-TESTS for missing tests to write
35 o When the test-suite fails, we do not remove the git repo created
36   for the test in the /tmp/ dir
37 o Some tests still have hardcoded data
38 o Currently ltcommit-suite uses ltrevlist functions but it shouldn't,
39   because a function can only be used after it's tested. The better to
40   to do here is to change ltcommit-suite to use a hardcoded commit
41   buffer instead of relying on ltrevlist's functions
42 o ltrevlist-suite is bad written, its tests are big and doesn't
43   follow the rule of first testing a function before using it.
44   Refactoring is required here.
45 o Test coverage is a cool idea (see libcheck's manual)
47 ltcommit
48 --------
50 o git_commit_parent() is missing
51 o A lot of functions can share common code (eg, _date()s)
53 ltrevlist
54 ---------
56 o Implement missing revlist options