X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=TODO;h=80e197e49181cb53f171fa1a11fb80cd65fbf9a3;hb=f237cd9bae1e83a9848b3ef3b2112b75f52a2535;hp=b5cbe4846b117fdd5fb769e23918f10129fcbe49;hpb=c118bd1ed23ad102ccfdce9ffd54e9d3b053708c;p=git.git diff --git a/TODO b/TODO index b5cbe484..80e197e4 100644 --- a/TODO +++ b/TODO @@ -1,10 +1,57 @@ -What to expect after 0.99.5 +What to expect after 0.99.6 =========================== 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. +a hint. 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'. + + - 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. + + - 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. + + 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. + + 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. Documentation @@ -14,35 +61,21 @@ Documentation migration and update the cvs-migration documentation. Link the documentation from the main git.txt page. -* Link howto docs from the git.txt page. [DONE] - -* Update the SubmittingPatches document to add MUA specific - hints on how to disable unwanted MIME and flowed-text by - collecting past list postings [DONE]. Accept patches from - people who were hit by shiny blue bat to update the same [IN - PROGRESS]. +* Accept patches from people who were hit by shiny blue bat to + update the SubmittingPatches. * 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. - -* Review the existing docs and see if the repository - organization needs to be clarified further [STILL NEEDSWORK]. + support for this (but see below about optimized cloning). -* Update tutorial to cover shared repository style a bit more - [DONE], maybe with a toy project that involves two or three - repositories. +* Maybe update tutorial with a toy project that involves two or + three developers.. * Update tutorial to cover setting up repository hooks to do - common tasks. [IN PROGRESS] + common tasks. -* Get help to properly use asciidoc in tutorial [Heck, ended up - learning it myself, DONE]. - -* Maybe justify and demonstrate an Octopus in the tutorial - [STILL NEEDSWORK]. Add it to the glossary [Thanks Johannes, - DONE]. +* Accept patches to finish missing docs. Technical (heavier) @@ -51,7 +84,21 @@ 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. - [STARTED TESTING PATCH FROM DANIEL] + [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 [tested and in proposed updates]. * We might want to optimize cloning with GIT native transport not to explode the pack, and store it in objects/pack instead. @@ -60,44 +107,39 @@ Technical (heavier) 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. +* Maybe a pack optimizer. + +* Maybe an Emacs VC backend. Technical (milder) ------------------ -* When the branch head pointed by $GIT_DIR/HEAD changes while - the index file and working tree are looking the other way - (e.g. somebody pushed into your repository, or you ran "git - fetch" to update the ref your working tree is on), "git - checkout" without -f gets confused. Figure out a good way to - handle this. [DONE] +* Tool renames. Give fixup patch for at least Cogito and StGIT. + [As of 2005-09-09 evening US/Pacific, the "master" branch has + what should go in 0.99.7 including gitenv() removal]. - We still have the same issue with "git fetch". Fetching into - the branch one is on _may_ need to do the same thing as - fetching into anonymous head and then do the resolve. At - least it needs a warning. [DONE] +* Have Daniel's read-tree graduate from "pu" after plugging leaks. -* "git commit -m" should work for initial commits and perhaps - merge commits as well. Warning about merge is still a good - thing to do, while -m is useful in scripted non-interactive - use, so we need to be careful. [DONE] +* Implement a merge backend using Daniel's read-tree [DONE]. -* Encourage concrete proposals to commit log message templates - we discussed some time ago. +* Rename 'git-merge-resolve' to 'git-merge-stupid' and + 'git-merge-multibase' to 'git-merge-resolve'; the former is + for historical curiosity and comparison purposes only and not + to be used in real applications so remove it from the default + strategies list [DONE]. -* Bug Ryan and work with him to update send-email easier to use. - [Resurrected it for Debian build.] +* 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. -* Look at portability fixes from Jason Riedy +* Encourage concrete proposals to commit log message templates + we discussed some time ago. - http://www.cs.berkeley.edu/~ejr/gits/git.git#portable +* Bug Martin for archimport script documentation. - [Applied. Burned by one of them and backed out, but otherwise - looks OK.] +* More portability. * Accept patches to cause "read-tree -u" delete a directory when it makes it empty. @@ -107,76 +149,77 @@ Technical (milder) * Perhaps accept patches to do undo/redo. -* MIMEified applymbox to grok B and Q encodings in headers and - turn them into UTF-8; unwrap QP; explode multipart. - [DONE. waiting for a bug to happen ;-) ] +* Perhaps accept patch to optionally allow '--fuzz' in + 'git-apply'. -* "git cherry-pick" that applies the patch an existing commit - introduces in its ancestry chain, possibly using the 3-way - merge machinery. [DONE] +* Maybe grok PGP signed text/plain in applymbox as well. -* Update rebase using the cherry-pick command. [DONE] - -* Redo "git revert" using 3-way merge machinery. [DONE] +* 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. * A tool to detect, show and prune already merged topic branches. -* Set up an automated documentation rebuilding procedure at - kernel.org, using update hook mechanism. [DONE] Describe it - in a howto form [DONE]. +* "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. + + Do not name it /lost+found/; that would probably confuse + things that mistake it a mount point (not our code but + somebody else's). * Enhance "git repack" to not always use --all; this would be handy if the repository contains wagging heads like "pu" in git.git repository. -* Accept and apply "git repack --all" patch, except the part - that removes the existing packs. [DONE] - * 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. -* Add names to all nodes in show-branch [DONE]. - * Option to limit rename detection for more than N paths. +* Marking copy seems to be broken when A,B => B,C rename + happens; we incorrectly say B stays, which makes the new B + copy of old A, not rename. -Technical (trivial) -------------------- +* 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. -* Look at and merge Debian fixes from Tommi [Done]. +* Output full path in the "git-rev-list --objects" output, not + just the basename, and see the improved clustering results in + better packing. -* Perhaps "git branch -d" to delete a branch. -* Remove "git clone-dumb-http". +Technical (trivial) +------------------- + +* Perhaps "git branch -d" to delete a branch. We probably need + some way to say "delete this branch because everything in this + should be merged in the master branch" and refuse the removal + if it is not true. * 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 - - -Initial repository Gotchas --------------------------- - -* `git fetch foo:bar` works OK, but `git checkout bar` - afterwards does not (missing `.git/HEAD`) - -* `git commit -s` did not add signoff for initial commit [DONE]. - -* `git status` does not work well when missing `.git/HEAD` [DONE]. - -* `git log` either; git-log-script uses die which does not exist - [DONE]. + git-update-index + git-ls-files + git-diff-files + git-diff-index + git-diff-tree + git-rev-list + git-rev-parse + +* In a freashly created empty repository, `git fetch foo:bar` + works OK, but `git checkout bar` afterwards does not (missing + `.git/HEAD`). Local Variables: