Re: index manipulation quickref

Hi,

I'm trying to collect all operations related to index from user perspective and corresponding commands. The list may be put to git wiki if people think it can help newbies:

update file content to index: git update-index file add a file to index: git add file delete a file from index: git update-index --remove --force-remove (or remove that file in workdir and do git update-index --remove) read a tree to index: git read-tree treeish, git reset treeish read a file from a tree to index: git ls-tree treeish file|git update-index --index-info --stdin copy a file from index to workdir: git checkout-index file refresh index: git update-index --refresh copy entire index to workdir: git checkout-index output a file from index to stdout: ?? (is there a command for this?) list files in index: git ls-files compare index and workdir file listing: git ls-files (with lots of options here) diff between workdir and index: git diff diff between index and a tree: git diff --cached treeish

Am I missing any operation here?

Nguyen Thai Ngoc Duy wrote:

Or "git add file" woth new git.

Or "git rm file" (old version did remove only from index, new version is to remove also from working directory if it matches HEAD)

Or just "git checkout -- file"

Or just "git checkout"

"git cat-file -p ::<filename>"

diff between workdir and tree: git diff <tree-ish> 

On 12/12/06, Nguyen Thai Ngoc Duy <pclouds@gmail.com> wrote:

Cool. But for "index-newbies" not "git-newbies" :)

We could add (if exists) the porcelain-ish equivalent as:

update file content to index:
  git update-index file
  git add file (the development version)

add a file to index:
  git update-index --add file
  git add file

delete a file from index:
  git update-index --remove [--force-remove] file
  git rm file

read a tree to index:
  git read-tree treeish
  git reset commit-ish # It changes also the HEAD

read a file from a tree to index:
  git ls-tree treeish file | git update-index --index-info --stdin
  N/A

copy a file from index to workdir:
  git checkout-index file
  git checkout file

refresh index:
  git update-index --refresh
  git status # It does more things

copy entire index to workdir:
  git checkout-index
  git checkout -f

output a file from index to stdout:
  git cat-file blob :file (or :n:file, where n=0,1,2,3 are the unmerged stage)
  ??

list files in index:
  git ls-files
  ??

compare index and workdir file listing:
  git ls-files (with lots of options here)
  git status?

diff between workdir and index:
  git diff-files
  git diff

diff between index and a tree:
  git diff-index --cached treeish
  git diff --cached treeish

"Nguyen Thai Ngoc Duy" <pclouds@gmail.com> writes:

I think this goes in the wrong direction. For "newbies" the Porcelain-ish set is supposed to be enough and if there is something missing that they need to do update-index command itself or a pipeline that involves update-index to achieve common tasks, we should enhance Porcelain-ish that captures the pattern.

I think quick-ref for Porcelain writers would not hurt, but they have manuals.

On 12/13/06, Junio C Hamano <junkio@cox.net> wrote:

It is supposed to be porcelain command only. I figure what operation a user may need when manipulating index, then find the corresponding porcelain command.

As you can see, we have porcelain commands for most of operations. The missing piece is reset a file in index (and maybe "git cat-file ::file" -- it's too cryptic). Hopefully "git reset -- file" will be implemented soon.