Andrew's git - gitweb.git/blob - submodule-config.h

   1#ifndef SUBMODULE_CONFIG_CACHE_H
   2#define SUBMODULE_CONFIG_CACHE_H
   3
   4#include "cache.h"
   5#include "config.h"
   6#include "hashmap.h"
   7#include "submodule.h"
   8#include "strbuf.h"
   9
  10/*
  11 * Submodule entry containing the information about a certain submodule
  12 * in a certain revision.
  13 */
  14struct submodule {
  15        const char *path;
  16        const char *name;
  17        const char *url;
  18        int fetch_recurse;
  19        const char *ignore;
  20        const char *branch;
  21        struct submodule_update_strategy update_strategy;
  22        /* the object id of the responsible .gitmodules file */
  23        struct object_id gitmodules_oid;
  24        int recommend_shallow;
  25};
  26
  27#define SUBMODULE_INIT { NULL, NULL, NULL, RECURSE_SUBMODULES_NONE, \
  28        NULL, NULL, SUBMODULE_UPDATE_STRATEGY_INIT, { { 0 } }, -1 };
  29
  30struct submodule_cache;
  31struct repository;
  32
  33extern void submodule_cache_free(struct submodule_cache *cache);
  34
  35extern int parse_submodule_fetchjobs(const char *var, const char *value);
  36extern int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg);
  37struct option;
  38extern int option_fetch_parse_recurse_submodules(const struct option *opt,
  39                                                 const char *arg, int unset);
  40extern int parse_update_recurse_submodules_arg(const char *opt, const char *arg);
  41extern int parse_push_recurse_submodules_arg(const char *opt, const char *arg);
  42extern void repo_read_gitmodules(struct repository *repo);
  43extern void gitmodules_config_oid(const struct object_id *commit_oid);
  44const struct submodule *submodule_from_name(struct repository *r,
  45                                            const struct object_id *commit_or_tree,
  46                                            const char *name);
  47const struct submodule *submodule_from_path(struct repository *r,
  48                                            const struct object_id *commit_or_tree,
  49                                            const char *path);
  50void submodule_free(struct repository *r);
  51int print_config_from_gitmodules(struct repository *repo, const char *key);
  52int config_set_in_gitmodules_file_gently(const char *key, const char *value);
  53
  54/*
  55 * Returns 0 if the name is syntactically acceptable as a submodule "name"
  56 * (e.g., that may be found in the subsection of a .gitmodules file) and -1
  57 * otherwise.
  58 */
  59int check_submodule_name(const char *name);
  60
  61/*
  62 * Note: these helper functions exist solely to maintain backward
  63 * compatibility with 'fetch' and 'update_clone' storing configuration in
  64 * '.gitmodules'.
  65 *
  66 * New helpers to retrieve arbitrary configuration from the '.gitmodules' file
  67 * should NOT be added.
  68 */
  69extern void fetch_config_from_gitmodules(int *max_children, int *recurse_submodules);
  70extern void update_clone_config_from_gitmodules(int *max_jobs);
  71
  72#endif /* SUBMODULE_CONFIG_H */