thodg/libgit2/src/submodule.h

• Show log

  Commit

• Hash : e807860f
  Author :
  Date : 2013-06-27T16:52:38
  

  Add timestamp check to submodule status
  
  This is probably not the final form of this change, but this is
  a preliminary version of checking a timestamp to see if the cached
  working directory HEAD OID matches the current.  Right now, this
  uses the timestamp on the index and is, like most of our timestamp
  checking, subject to having only second accuracy.
  

Download

• src/submodule.h

• /*
   * Copyright (C) the libgit2 contributors. All rights reserved.
   *
   * This file is part of libgit2, distributed under the GNU GPL v2 with
   * a Linking Exception. For full terms see the included COPYING file.
   */
  #ifndef INCLUDE_submodule_h__
  #define INCLUDE_submodule_h__
  
  #include "git2/submodule.h"
  #include "git2/repository.h"
  #include "fileops.h"
  
  /* Notes:
   *
   * Submodule information can be in four places: the index, the config files
   * (both .git/config and .gitmodules), the HEAD tree, and the working
   * directory.
   *
   * In the index:
   * - submodule is found by path
   * - may be missing, present, or of the wrong type
   * - will have an oid if present
   *
   * In the HEAD tree:
   * - submodule is found by path
   * - may be missing, present, or of the wrong type
   * - will have an oid if present
   *
   * In the config files:
   * - submodule is found by submodule "name" which is usually the path
   * - may be missing or present
   * - will have a name, path, url, and other properties
   *
   * In the working directory:
   * - submodule is found by path
   * - may be missing, an empty directory, a checked out directory,
   *   or of the wrong type
   * - if checked out, will have a HEAD oid
   * - if checked out, will have git history that can be used to compare oids
   * - if checked out, may have modified files and/or untracked files
   */
  
  /**
   * Description of submodule
   *
   * This record describes a submodule found in a repository.  There should be
   * an entry for every submodule found in the HEAD and index, and for every
   * submodule described in .gitmodules.  The fields are as follows:
   *
   * - `name` is the name of the submodule from .gitmodules.
   * - `path` is the path to the submodule from the repo root.  It is almost
   *    always the same as `name`.
   * - `url` is the url for the submodule.
   * - `update` is a git_submodule_update_t value - see gitmodules(5) update.
   * - `update_default` is the update value from the config
   * - `ignore` is a git_submodule_ignore_t value - see gitmodules(5) ignore.
   * - `ignore_default` is the ignore value from the config
   * - `fetch_recurse` is 0 or 1 - see gitmodules(5) fetchRecurseSubmodules.
   *
   * - `owner` is the git_repository containing this submodule
   * - `flags` after for internal use, tracking where this submodule has been
   *   found (head, index, config, workdir) and known status info, etc.
   * - `head_oid` is the SHA1 for the submodule path in the repo HEAD.
   * - `index_oid` is the SHA1 for the submodule recorded in the index.
   * - `wd_oid` is the SHA1 for the HEAD of the checked out submodule.
   * - `wd_index_path` is the path to the index of the checked out submodule
   * - `wd_last_index` is a timestamp of that submodule index so we can
   *   quickly check if the `wd_oid` should be rechecked
   * - `refcount` tracks how many hash table entries in the
   *   git_submodule_cache there are for this submodule.  It only comes into
   *   play if the name and path of the submodule differ.
   *
   * If the submodule has been added to .gitmodules but not yet git added,
   * then the `index_oid` will be zero but still marked valid.  If the
   * submodule has been deleted, but the delete has not been committed yet,
   * then the `index_oid` will be set, but the `url` will be NULL.
   */
  struct git_submodule {
  	/* information from config */
  	char *name;
  	char *path; /* important: may point to same string data as "name" */
  	char *url;
  	git_submodule_update_t update;
  	git_submodule_update_t update_default;
  	git_submodule_ignore_t ignore;
  	git_submodule_ignore_t ignore_default;
  	int fetch_recurse;
  
  	/* internal information */
  	git_repository *owner;
  	uint32_t flags;
  	git_oid head_oid;
  	git_oid index_oid;
  	git_oid wd_oid;
  	char *wd_head_path;
  	git_futils_filestamp wd_stamp;
  	int refcount;
  };
  
  /* Additional flags on top of public GIT_SUBMODULE_STATUS values */
  enum {
  	GIT_SUBMODULE_STATUS__WD_SCANNED          = (1u << 20),
  	GIT_SUBMODULE_STATUS__HEAD_OID_VALID      = (1u << 21),
  	GIT_SUBMODULE_STATUS__INDEX_OID_VALID     = (1u << 22),
  	GIT_SUBMODULE_STATUS__WD_OID_VALID        = (1u << 23),
  	GIT_SUBMODULE_STATUS__HEAD_NOT_SUBMODULE  = (1u << 24),
  	GIT_SUBMODULE_STATUS__INDEX_NOT_SUBMODULE = (1u << 25),
  	GIT_SUBMODULE_STATUS__WD_NOT_SUBMODULE    = (1u << 26),
  	GIT_SUBMODULE_STATUS__INDEX_MULTIPLE_ENTRIES = (1u << 27),
  };
  
  #define GIT_SUBMODULE_STATUS__CLEAR_INTERNAL(S) \
  	((S) & ~(0xFFFFFFFFu << 20))
  
  #endif
  

Download