X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=TODO;h=15ecb597dbf474058a7071c7db75aa0010941ae9;hb=c3b9ed08caf84bca24902b3b2750ad61e411da98;hp=cd6c5b8e883620be438503120fda423035a9c712;hpb=7bd5db67c1e3c95a4b15117b030e3dae05fb5148;p=git.git diff --git a/TODO b/TODO index cd6c5b8e..15ecb597 100644 --- a/TODO +++ b/TODO @@ -1,69 +1,49 @@ -What to expect after 0.99.6 -=========================== +The GIT To-Do File +================== -This is written in a form of to-do list for me, so if I say -"accept patch", it means I do not currently plan to do that -myself. People interested in seeing it materialize please take -a hint. The latest copy of this document is found at + The latest copy of this document is found at http://kernel.org/git/?p=git/git.git;a=blob;hb=todo;f=TODO -Tool Renames Plan ------------------ - - All non-binary commands will lose -script suffix in - $(bindir). The source to git-foo will be either git-foo.sh - or git-foo.perl in the source tree, and the documentation - will be in Documentation/git-foo.txt. +Tool Renames Plan +================= - - The commands whose names have 'cache' to mean 'index file' - will get 'cache' in their names replaced with 'index'. For - git-fsck-cache and git-convert-cache, 'cache' will be - replaced with 'objects'. + - In 0.99.9, the backward compatible symbolic links in + $(bindir) will be removed. - - The commit walkers will have 'pull' in their names replaced - with 'fetch'. 'git-ssh-push' will become 'git-ssh-upload'. + git-ssh-push and git-ssh-pull pair is not going away if ever. + Each of these old-name commands continues to invoke its + old-name counterpart on the other end. - - We continue to follow the convention to name the C source - file that contains the main program of 'git-foo' command - 'foo.c'. That means we will have 'fsck-objects.c', for - example. - - At this moment, I am not planning to rename the symbols used - in programs, nor any library sources. "cache.h" will stay - "cache.h", so does "read-cache.c". "struct cache_entry" and - "ce_match_stat()" will keep their names. We _might_ want to - rename them in later rounds but not right now. +What to expect after 0.99.8 +=========================== - - In 0.99.7, all renamed commands will have symbolic links in - $(bindir) so that old names continue to work. These backward - compatible symlinks will not be present in documentation, - though. Especially, the main documentation, git(7) will talk - about the new names. Old environment names defined in - gitenv() will also be removed in this release. +This is written in a form of to-do list for me, so if I say +"accept patch", it means I do not currently plan to do that +myself. People interested in seeing it materialize please take +a hint. Also whatever I marked "Perhaps" do not have to happen +if ever -- only if somebody cares enough and submits a clean +patch, perhaps ;-). - Tentatively we aim to do this on Sep 17th. - - In 0.99.8, we do not install these backward compatible - symbolic links in $(bindir) anymore. The Makefile will have - a target to remove old symlinks from $(DESTDIR)$(bindir) you - can run manually to help you clean things up. +Documentation +------------- - The timeframe for this is around Oct 1st, but I could be - talked into delaying the symlink removal if Porcelain people - find this schedule too tight. +* Document the ref naming restrictions [DONE]. +* David Ho's report suggests whatchanged documentation should + mention -m as "commonly used options". Steal Linus' + response [DONE]. -Documentation -------------- +* Help Jon Loeliger to find place in the documentation to place + his drawing. * Accept patches from people who actually have done CVS migration and update the cvs-migration documentation. Link the documentation from the main git.txt page. -* Accept patches from people who were hit by shiny blue bat to - update the SubmittingPatches [ONGOING]. - * Talk about using rsync just once at the beginning when initializing a remote repository so that local packs do not need to be expanded. I personally do not think we need tool @@ -75,121 +55,222 @@ Documentation * Update tutorial to cover setting up repository hooks to do common tasks. -* Accept patches to finish missing docs. +* Do we still have missing docs? If so accept patches to finish + them. + +* Accept patches to talk about "Whoops, it broke. What's + next?". + +* Accept patches to make formatted tables in asciidoc to work + well in both html and man pages (see git-diff(1)). Technical (heavier) ------------------- -* Tony Luck reported an unfortunate glitch in the 3-way merge. - Encourage discussions to come up with a not-so-expensive way - to catch the kind of ambiguities that led to his misery. - [Daniel's patch looks quite promising, so is the one from - Fredrik.] - -* HPA has two projects, klibc and klibc-kbuild, that have large - set of overlapping files in different paths (i.e. one has many - renames from the other). There currently is no way for git to - help keep these two trees in sync, merging criss-cross between - them. The merge logic should be able to take advantage of - rename/copy detection smarts git-diff-* family has. Linus, - me, and Daniel outlined a smarter merge strategy for this. - Try them out. - -* To make it easier to experiment with different merge - strategies, make git-merge driver that will run merge backends - for the best merge [Illustration of concept patch sent out, - untested yet]. - * We might want to optimize cloning with GIT native transport not to explode the pack, and store it in objects/pack instead. We would need a tool to generate an idx file out of a pack file for this. Also this itself may turn out to be a bad idea, making the set of packs in repositories everybody has - different from each other. + different from each other. [DONE; git-index-pack by Sergey, + tweaking clone by me] + +* Git daemon, when deployed at kernel.org, might turn out to be + quite a burden, since it needs to generate customized packs + every time a new request comes in. It may be worthwhile to + precompute some packs for popular sets of heads downloaders + have and serve that, even if that could give more than the + client asks for in some cases. We will know about this soon + enough [DONE part to allow using precomputed pack, but not + dynamic caching part]. + +* Libification. There are many places "run once" mentality is + ingrained in the management of basic data structures, which + need to be fixed. [Matthias Urlichs is already working on + this: ; Post + 1.0]. * Maybe a pack optimizer. + Given a set of objects and a set of refs (probably a handful + branch heads and point release tags), find a set of packs to + allow reasonably minimum download for all of these classes of + people: (1) somebody cloning the repository from scratch, (2) + somebody who tends to follow the master branch head reasonably + closely, (3) somebody who tends to follow only the point + releases. + * Maybe an Emacs VC backend. +* 'git split-projects'? This requires updated 'git-rev-list' to + skip irrelevant commits. + Message-ID: + +* Look at libified GNU diff CVS seems to use, or libxdiff. + [Daniel has his own diff tool almost ready to start + integrating and testing; Post 1.0] + +* Accept patches to fetch multiple objects by HTTP in parallel. + [DONE] + +* Plug-in file-level merges [Post 1.0]. + +* Per-repository configuration mechanism [DONE by Linus]. + Technical (milder) ------------------ -* Tool renames. Give fixup patch for at least Cogito and StGIT. - [As of this writing 2005-09-08 evening US/Pacific, the - "master" has what should go in 0.99.7 except gitenv() removal]. +* Merlyn reports trouble with http fetch [Hopefully solved by + Nick's updates]. +* Maybe look at Cogito and see if I can help Pasky to adjust to + the later core features? Zack Brown's "cg-seek leaving empty + directories" problem is a good example of this. -* Have Daniel's read-tree graduate from "pu" after plugging leaks. +* Perhaps detect cloning request in upload-pack and cache the + result for next cloning request until any of our refs change. -* Implement a merge backend using Daniel's read-tree. +* Perhaps accept more "want"s in upload-pack and do something + intelligent about it [Ongoing, by Johannes]. -* Accept Fredrik merge after renaming it (I want to name the - driver 'git merge'). Suggest where to place *.py stuff -- - probably in $(share)/git-core/ and add Makefile entry for - installation. +* Perhaps send less "want"s from fetch-pack [DONE by JS]. -* Encourage concrete proposals to commit log message templates - we discussed some time ago. +* Look at svn importer Smurf has. There is a small cvsimport + update in his tree as well [DONE]. -* Bug Martin for archimport script documentation. +* Decide the notation of "peeling the onion" operator, and + implement it in sha1_name.c. Perhaps postfix "^{}" to mean + "peel and expect anything", "^{blob}" to mean "peel and barf + unless blob". The current "^0" becomes shorthand for + "^{commit}". [DONE] -* More portability. +* Quote the URL so that libcurl's metecharacter mechanism would + not kick in [DONE]. -* Accept patches to cause "read-tree -u" delete a directory when - it makes it empty. +* Review the Makefile variables and exporting rules for them, + while looking at prefix passing by Kai Ruemmler [DONE]. + +* Review the 'sparse object database' change by Linus and move + the first phase of it to the "master" branch [DONE]. -* Perhaps accept patches to introduce the concept of "patch flow - expressed as ref mappings" Josef has been advocating about. +* Decide on mmap(). I am inclined to just stick to mmap + replacement by Johannes Schindelin and do nothing else right + now, except perhaps drop the writing-back support [DONE]. + +* Revisit Santi's patch to move commit temorary files out of the + working tree toplevel [DONE]. + +* More generally, review the use of temporary files again. + Assuming writable $GIT_DIR is more acceptable, but the + working tree toplevel may not be in a rare usage pattern. + +* Encourage concrete proposals to commit log message templates + we discussed some time ago. + +* Accept patches to cause "read-tree -u" delete a directory when + it makes it empty [DONE]. * Perhaps accept patches to do undo/redo. * Perhaps accept patch to optionally allow '--fuzz' in 'git-apply'. -* Maybe grok PGP signed text/plain in applymbox as well. +* Allow 'git apply' to accept GNU diff 2.7 output that forgets + to say '\No newline' if both input ends with incomplete + lines. -* Perhaps a tool to revert a single file to pre-modification - state? git-cat-file blob `git-ls-files | grep foo` >foo or - git-cat-file blob `git-ls-tree HEAD foo` >foo? What should - the command be called? git-revert is taken so is - git-checkout. +* What to do with TABs and LFs in pathnames without breaking GNU + patch? [DONE -- go with GNU patch extension proposed by Paul]. -* A tool to detect, show and prune already merged topic - branches. +* Adjust apply.c to proposed GNU patch extension that quotes \n + and \t in C style, inside "". [DONE] -* "Lost and Found"; find the minimum number of dangling commits - from the fsck-objects output to make everybody not dangling, - and link them under $GIT_DIR/refs/lost-found/. Then - show-branch or gitk can be used to find any lost commit. +* Adjust diff.c to the same. [DONE] - Do not name it /lost+found/; that would probably confuse - things that incorrectly assumes that is a mount point (not our - code but somebody else's). +* Maybe grok PGP signed text/plain in applymbox as well. + +* Perhaps a tool to revert a single file to pre-modification + state? People with BK background know this operation as + 'clean'. 'git checkout [-f] ent [path...]' was suggested by + Matthias Urlichs which sounds a natural extention to what the + command currently does [DONE with a prodding by Linus]. * Enhance "git repack" to not always use --all; this would be handy if the repository contains wagging heads like "pu" in git.git repository. -* Internally split the project into non-doc and doc parts; add - an extra root for the doc part and merge from it; move the - internal doc source to a separate repository, like the +Meta - repository; experiment if this results in a reasonable - workflow, and document it in howto form if it does. - -* Option to limit rename detection for more than N paths. - * Make rebase restartable; instead of skipping what cannot be automatically forward ported, leave the conflicts in the work tree, have the user resolve it, and then restart from where it - left off. + left off [mechanism mostly done]. + +* Output full path in the "git-rev-list --objects" output, not + just the basename, and see the improved clustering results in + better packing [Tried, but did not work out well]. + +* Updated git-changes-script Jeff Garzik needs [Inquiry for + external spec sent out with a quick hack. Will know if that + is what he needs hopefully soon]. + +* An mechanism to ignore filesystem mode bits altogether [DONE]. Technical (trivial) ------------------- -* Perhaps "git branch -d" to delete a branch. +* Peter Hagervall's sparse fix [DONE]. + +* Alex Riesen reported that hooks are in effect in tests. + Should fix [DONE]. + +* Disallow [\001-\040\177] byte values from ref names. Also we + need to disallow ':' (used in refspec), '^' and '~' (postfix + "peel the onion" operators), and '..' ("ref1..ref2" notation + becomes ambiguous otherwise) [DONE]. + +* Update fetch-pack and clone-pack to ignore funny refs from the + other end, while making sure peek-remote does not discard them. + [DONE] + +* Update upload-pack to send tag^{}. This would hopefully help + Pasky's automated tag tracking, and also Martin's findtags. + [DONE] + +* Adjust update-index to quoted --index-info [DONE]. + +* Prepare apply.c changes for maint branch (0.99.8e) [DONE]. + +* Perhaps show ^{commit}, ^{tree} instead of ^{} from ls-remote? [NO] + +* Re-adjust maint branch for the above if we did so. [NOT NEEDED] + +* short SHA1 naming is not enforcing uniqueness. Should fix [DONE]. + +* 'git repack' can be DOSed. Should fix [DONE]. + +* Stop installing the old-name symlinks [IN 0.99.9]. + +* 'git merge-projects'? + + Subject: Re: Merges without bases + References: <1125004228.4110.20.camel@localhost.localdomain> + Date: Thu, 25 Aug 2005 15:26:36 -0700 + Message-ID: <7vvf1tps9v.fsf@assigned-by-dhcp.cox.net> + +* 'git lost-and-found'? Link dangling commits found by + fsck-objects under $GIT_DIR/refs/lost-found/. Then + show-branch or gitk can be used to find any lost commit. [A + feeler patch sent out. Very underwhelming response X-<.] + + Do not name it /lost+found/; that would probably confuse + things that mistake it a mount point (not our code but + somebody else's). + +* Add simple globbing rules to git-show-branch so that I can + say 'git show-branch --heads "ko-*"' (ko-master, ko-pu, and + ko-rc are in refs/tags/). * We would want test scripts for the relative directory path stuff Linus has been working on. So far, the following