Skip to content

Commit 501bf60

Browse files
committed
roadmap added to docs to give an idea of tasks still to be done, especially if 0.2 should be released one day
1 parent 997b761 commit 501bf60

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

doc/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Contents:
1313
intro
1414
tutorial
1515
reference
16+
roadmap
1617

1718
Indices and tables
1819
==================

doc/roadmap.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=====================
2+
What's next in: 0.2.0
3+
=====================
4+
1. **Docs Review**
5+
* all documentation strings must be reviewed for resT correctness. Additionally they should be adjusted to use the sphinx fields like ":param:" and ":return:".
6+
2. **Review git-python's ability to parse the progress information sent when fetching and pushing**
7+
* Up to git 1.6.5, a push would still send progress. Then up to git 1.7.0 it will not produce progress to non-ttys anymore, making git-pythons test fail. Now git is implementing new --progress flags which would allow to enforce the sending of progress messages. This needs to be researched, implementation needs adjustments to assure we get the best possible progress results with git 1.6x as well as with git 1.7x.
8+
9+
=====================
10+
What's next in: 0.2.1
11+
=====================
12+
1. **Research possibility to read the object database ( including packs and alternates support ) directly.**
13+
* Sample code can be found in dulwich, but it will have to be adjusted to perform better through configurable caching. Currently git-python can retrieve the data of about 10k smallish objects / s, the python implementation shouldn't be much slower than that.

0 commit comments

Comments
 (0)