stash: remove now superfluos help for "stash push"
[git.git] / tmp-objdir.h
blobb1e45b4c75d2d8877dce507a7f2134aa93da8e17
1 #ifndef TMP_OBJDIR_H
2 #define TMP_OBJDIR_H
4 /*
5 * This API allows you to create a temporary object directory, advertise it to
6 * sub-processes via GIT_OBJECT_DIRECTORY and GIT_ALTERNATE_OBJECT_DIRECTORIES,
7 * and then either migrate its object into the main object directory, or remove
8 * it. The library handles unexpected signal/exit death by cleaning up the
9 * temporary directory.
11 * Example:
13 * struct tmp_objdir *t = tmp_objdir_create();
14 * if (!run_command_v_opt_cd_env(cmd, 0, NULL, tmp_objdir_env(t)) &&
15 * !tmp_objdir_migrate(t))
16 * printf("success!\n");
17 * else
18 * die("failed...tmp_objdir will clean up for us");
22 struct tmp_objdir;
25 * Create a new temporary object directory; returns NULL on failure.
27 struct tmp_objdir *tmp_objdir_create(void);
30 * Return a list of environment strings, suitable for use with
31 * child_process.env, that can be passed to child programs to make use of the
32 * temporary object directory.
34 const char **tmp_objdir_env(const struct tmp_objdir *);
37 * Finalize a temporary object directory by migrating its objects into the main
38 * object database, removing the temporary directory, and freeing any
39 * associated resources.
41 int tmp_objdir_migrate(struct tmp_objdir *);
44 * Destroy a temporary object directory, discarding any objects it contains.
46 int tmp_objdir_destroy(struct tmp_objdir *);
49 * Add the temporary object directory as an alternate object store in the
50 * current process.
52 void tmp_objdir_add_as_alternate(const struct tmp_objdir *);
54 #endif /* TMP_OBJDIR_H */