git-sh-setup(1) [osx man page]

GIT-SH-SETUP(1) 						    Git Manual							   GIT-SH-SETUP(1)

NAME

       git-sh-setup - Common Git shell script setup code

SYNOPSIS

       . "$(git --exec-path)/git-sh-setup"

DESCRIPTION

       This is not a command the end user would want to run. Ever. This documentation is meant for people who are studying the Porcelain-ish
       scripts and/or are writing new ones.

       The git sh-setup scriptlet is designed to be sourced (using .) by other shell scripts to set up some variables pointing at the normal Git
       directories and a few helper shell functions.

       Before sourcing it, your script should set up a few variables; USAGE (and LONG_USAGE, if any) is used to define message given by usage()
       shell function. SUBDIRECTORY_OK can be set if the script can run from a subdirectory of the working tree (some commands do not).

       The scriptlet sets GIT_DIR and GIT_OBJECT_DIRECTORY shell variables, but does not export them to the environment.

FUNCTIONS

       die
	   exit after emitting the supplied error message to the standard error stream.

       usage
	   die with the usage message.

       set_reflog_action
	   Set GIT_REFLOG_ACTION environment to a given string (typically the name of the program) unless it is already set. Whenever the script
	   runs a git command that updates refs, a reflog entry is created using the value of this string to leave the record of what command
	   updated the ref.

       git_editor
	   runs an editor of user's choice (GIT_EDITOR, core.editor, VISUAL or EDITOR) on a given file, but error out if no editor is specified
	   and the terminal is dumb.

       is_bare_repository
	   outputs true or false to the standard output stream to indicate if the repository is a bare repository (i.e. without an associated
	   working tree).

       cd_to_toplevel
	   runs chdir to the toplevel of the working tree.

       require_work_tree
	   checks if the current directory is within the working tree of the repository, and otherwise dies.

       require_work_tree_exists
	   checks if the working tree associated with the repository exists, and otherwise dies. Often done before calling cd_to_toplevel, which
	   is impossible to do if there is no working tree.

       require_clean_work_tree <action> [<hint>]
	   checks that the working tree and index associated with the repository have no uncommitted changes to tracked files. Otherwise it emits
	   an error message of the form Cannot <action>: <reason>. <hint>, and dies. Example:

	       require_clean_work_tree rebase "Please commit or stash them."

       get_author_ident_from_commit
	   outputs code for use with eval to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given commit.

       create_virtual_base
	   modifies the first file so only lines in common with the second file remain. If there is insufficient common material, then the first
	   file is left empty. The result is suitable as a virtual base input for a 3-way merge.

GIT

       Part of the git(1) suite

Git 2.17.1							    10/05/2018							   GIT-SH-SETUP(1)

Check Out this Related Man Page

GIT-UPLOAD-ARCHIVE(1)                                               Git Manual                                               GIT-UPLOAD-ARCHIVE(1)

NAME

       git-upload-archive - Send archive back to git-archive

SYNOPSIS

       git upload-archive <directory>

DESCRIPTION

       Invoked by git archive --remote and sends a generated archive to the other end over the Git protocol.

       This command is usually not invoked directly by the end user. The UI for the protocol is on the git archive side, and the program pair is
       meant to be used to get an archive from a remote repository.

SECURITY

       In order to protect the privacy of objects that have been removed from history but may not yet have been pruned, git-upload-archive avoids
       serving archives for commits and trees that are not reachable from the repository's refs. However, because calculating object reachability
       is computationally expensive, git-upload-archive implements a stricter but easier-to-check set of rules:

        1. Clients may request a commit or tree that is pointed to directly by a ref. E.g., git archive --remote=origin v1.0.

        2. Clients may request a sub-tree within a commit or tree using the ref:path syntax. E.g., git archive --remote=origin v1.0:Documentation.

        3. Clients may not use other sha1 expressions, even if the end result is reachable. E.g., neither a relative commit like master^ nor a
           literal sha1 like abcd1234 is allowed, even if the result is reachable from the refs.

       Note that rule 3 disallows many cases that do not have any privacy implications. These rules are subject to change in future versions of
       git, and the server accessed by git archive --remote may or may not follow these exact rules.

       If the config option uploadArchive.allowUnreachable is true, these rules are ignored, and clients may use arbitrary sha1 expressions. This
       is useful if you do not care about the privacy of unreachable objects, or if your object database is already publicly available for access
       via non-smart-http.

OPTIONS

       <directory>
           The repository to get a tar archive from.

GIT

       Part of the git(1) suite

Git 2.17.1                                                          10/05/2018                                               GIT-UPLOAD-ARCHIVE(1)

Linux and UNIX Man Pages

git-sh-setup(1) [osx man page]

Check Out this Related Man Page