Skip to content
  • Junio C Hamano's avatar
    hold_locked_index(): align error handling with hold_lockfile_for_update() · b3e83cc7
    Junio C Hamano authored
    
    
    Callers of the hold_locked_index() function pass 0 when they want to
    prepare to write a new version of the index file without wishing to
    die or emit an error message when the request fails (e.g. somebody
    else already held the lock), and pass 1 when they want the call to
    die upon failure.
    
    This option is called LOCK_DIE_ON_ERROR by the underlying lockfile
    API, and the hold_locked_index() function translates the paramter to
    LOCK_DIE_ON_ERROR when calling the hold_lock_file_for_update().
    
    Replace these hardcoded '1' with LOCK_DIE_ON_ERROR and stop
    translating.  Callers other than the ones that are replaced with
    this change pass '0' to the function; no behaviour change is
    intended with this patch.
    
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    ---
    
    Among the callers of hold_locked_index() that passes 0:
    
     - diff.c::refresh_index_quietly() at the end of "git diff" is an
       opportunistic update; it leaks the lockfile structure but it is
       just before the program exits and nobody should care.
    
     - builtin/describe.c::cmd_describe(),
       builtin/commit.c::cmd_status(),
       sequencer.c::read_and_refresh_cache() are all opportunistic
       updates and they are OK.
    
     - builtin/update-index.c::cmd_update_index() takes a lock upfront
       but we may end up not needing to update the index (i.e. the
       entries may be fully up-to-date), in which case we do not need to
       issue an error upon failure to acquire the lock.  We do diagnose
       and die if we indeed need to update, so it is OK.
    
     - wt-status.c::require_clean_work_tree() IS BUGGY.  It asks
       silence, does not check the returned value.  Compare with
       callsites like cmd_describe() and cmd_status() to notice that it
       is wrong to call update_index_if_able() unconditionally.
    b3e83cc7