X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=TODO;h=3c9946f252f614d9fb49e5bc7d96f4c03f517eb2;hb=9631a0e5ff90b2c559c14435fe43c33322d1ec2c;hp=f94b49b549eed49a561155d08043c4957e412641;hpb=28e50bdb5183ced6fd14ddb850d879f6178895be;p=git.git diff --git a/TODO b/TODO index f94b49b5..3c9946f2 100644 --- a/TODO +++ b/TODO @@ -1,190 +1,216 @@ -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. - - - 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'. - - - The commit walkers will have 'pull' in their names replaced - with 'fetch'. 'git-ssh-push' will become 'git-ssh-upload'. +Tool Renames Plan +================= - - 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. + - Immedately after 0.99.9, the backward compatible symbolic + links in $(bindir) will be removed [DONE]. - - 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. + 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. - - 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. + - There was a discussion to move bulk of the git-* programs out + of /usr/bin and use /usr/lib/git; the central mechanism was + done, but the actual move is postponed post 1.0. - 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. +What to expect after 0.99.9 +=========================== - 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. +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 ;-). Documentation ------------- +* Help Jon Loeliger to find place in the documentation to place + his drawing [DONE]. + * 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 support for this (but see below about optimized cloning). * Maybe update tutorial with a toy project that involves two or - three developers.. + three developers. * 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?" [Started]. + +* 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 [Outlined the idea; just do it]. - -* 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. - -* Maybe a pack optimizer. I am not convinced that packing all - objects into a single pack and removing all the existing panck - is the right way to go, since that would work against people - who already have those packs. +* Assess the side effects of "make the rest of the things + magically work from any subdirectory" change by Linus. It is + a good change in principle and we would like to have that + behaviour but some tool implementations I am sure are assuming + to never run from anywhere other than the top. [Post 1.0] + +* Ref namespace management. Perhaps use refs/local/ suggestion + by Linus. + +* 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] + +* Plug-in file-level merges [Post 1.0]. + Technical (milder) ------------------ -* Tool renames [STARTED]. +* merge-recursive needs to register conflicting paths as higher + stage entries in the index. For that, it first needs to + construct three trees whose paths are already renamed, and + call 3-way read-tree. -* Have Daniel's read-tree graduate from "pu" after plugging leaks. +* Binary package split. Plan laid out and discussion mostly + done. [RPM side done; Debian side delegated] -* Implement a merge backend using Daniel's read-tree. +* User-relative paths by Andreas Ericsson. [DONE] -* 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. +* Accessing configuration variables from C and from scripts by + Johannes [DONE]. -* Encourage concrete proposals to commit log message templates - we discussed some time ago. +* Proxing git:// connection by Paul Collins. [DONE] -* Bug Martin for archimport script documentation. +* Maybe look at Cogito and see if I can help Pasky to adjust to + the later core features? -* More portability. I dropped a SunOS patch on the floor by - somebody. +* Perhaps detect cloning request in upload-pack and cache the + result for next cloning request until any of our refs change. -* Accept patches to cause "read-tree -u" delete a directory when - it makes it empty. - -* Perhaps accept patches to introduce the concept of "patch flow - expressed as ref mappings" Josef has been advocating about. +* Encourage concrete proposals to commit log message templates + we discussed some time ago. * Perhaps accept patches to do undo/redo. -* Maybe grok PGP signed text/plain in applymbox as well. +* Perhaps accept patch to optionally allow '--fuzz' in + 'git-apply'. -* 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. +* Allow 'git apply' to accept GNU diff 2.7 output that forgets + to say '\No newline' if both input ends with incomplete + lines. -* A tool to detect, show and prune already merged topic - branches. +* Maybe grok PGP signed text/plain in applymbox as well. * 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. +* 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 [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]. -* Option to limit rename detection for more than N paths. +* Updated git-changes-script Jeff Garzik needs [Not needed -- + pull into local or borrow temporarily with alternate object + directories environment variable and use normal tools]. + +* Customizable init-db. Personally I think template mechanism + is good enough. Otherwise, maybe add hooks/post-init-db. + +* Make sure we do reasonable thing on binary files even in + cherry-pick and rebase [DONE]. + +* Binary diff detection fails if locale set to non English; even + GNU diff 2.8.1 and 2.8.7 in C locale say different things. At + least run diff under C locale (setenv LANG=C LC_ALL=C) for + 1.0. It might be better to have our own binary detection + logic, or even our own diff output without forking an external + diff. [The former _might_ make sense for 1.0, but the latter + is post 1.0]. Technical (trivial) ------------------- -* Perhaps "git branch -d" to delete a branch. +* Stop installing the old-name symlinks [DONE]. + +* '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. + [DONE] + + 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 - commands should be usable with relative directory paths: - - update-cache - ls-files - diff-files - diff-cache - diff-tree - rev-list - rev-parse + stuff Linus has been working on. Most of the C-level + commands should be usable with relative directory paths. * In a freashly created empty repository, `git fetch foo:bar` works OK, but `git checkout bar` afterwards does not (missing