summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2010-03-23 10:41:09 +0100
committerSebastian Thiel <byronimo@gmail.com>2010-03-23 10:41:09 +0100
commit501bf602abea7d21c3dbb409b435976e92033145 (patch)
tree081142c3a05b1c70a680bba9f41c4cccf4892917
parent997b7611dc5ec41d0e3860e237b530f387f3524a (diff)
downloadgitpython-501bf602abea7d21c3dbb409b435976e92033145.tar.gz
roadmap added to docs to give an idea of tasks still to be done, especially if 0.2 should be released one day
-rw-r--r--doc/index.rst1
-rw-r--r--doc/roadmap.rst13
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
index 19191272..cb7ee505 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -13,6 +13,7 @@ Contents:
intro
tutorial
reference
+ roadmap
Indices and tables
==================
diff --git a/doc/roadmap.rst b/doc/roadmap.rst
new file mode 100644
index 00000000..476f7668
--- /dev/null
+++ b/doc/roadmap.rst
@@ -0,0 +1,13 @@
+=====================
+What's next in: 0.2.0
+=====================
+ 1. **Docs Review**
+ * all documentation strings must be reviewed for resT correctness. Additionally they should be adjusted to use the sphinx fields like ":param:" and ":return:".
+ 2. **Review git-python's ability to parse the progress information sent when fetching and pushing**
+ * 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.
+
+=====================
+What's next in: 0.2.1
+=====================
+ 1. **Research possibility to read the object database ( including packs and alternates support ) directly.**
+ * 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.