get_worktrees() must return main worktree as first item even on error
authorNguyễn Thái Ngọc Duy <pclouds@gmail.com>
Mon, 28 Nov 2016 09:36:54 +0000 (16:36 +0700)
committerJunio C Hamano <gitster@pobox.com>
Mon, 28 Nov 2016 21:18:51 +0000 (13:18 -0800)
commita234563a3b329c8513fabbe9d8f9435987f10eb6
tree6564595b6de267b4778acbe0c3215570d1e4e6b0
parent96f09e2a1100d78aacad80a741c3046031fda6b4
get_worktrees() must return main worktree as first item even on error

This is required by git-worktree.txt, stating that the main worktree is
the first line (especially in --porcelain mode when we can't just change
behavior at will).

There's only one case when get_worktrees() may skip main worktree, when
parse_ref() fails. Update the code so that we keep first item as main
worktree and return something sensible in this case:

 - In user-friendly mode, since we're not constraint by anything,
   returning "(error)" should do the job (we already show "(detached
   HEAD)" which is not machine-friendly). Actually errors should be
   printed on stderr by parse_ref() (*)

 - In plumbing mode, we do not show neither 'bare', 'detached' or
   'branch ...', which is possible by the format description if I read
   it right.

Careful readers may realize that when the local variable "head_ref" in
get_main_worktree() is emptied, add_head_info() will do nothing to
wt->head_sha1. But that's ok because head_sha1 is zero-ized in the
previous patch.

(*) Well, it does not. But it's supposed to be a stop gap implementation
    until we can reuse refs code to parse "ref: " stuff in HEAD, from
    resolve_refs_unsafe(). Now may be the time since refs refactoring is
    mostly done.

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
builtin/worktree.c
t/t2027-worktree-list.sh
worktree.c