add

package
Version: v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 8, 2020 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package add git-add - Add file contents to the index.

SYNOPSIS

Reference: https://git-scm.com/docs/git-add

git add [--verbose | -v] [--dry-run | -n] [--force | -f] [--interactive | -i] [--patch | -p]
		[--edit | -e] [--[no-]all | --[no-]ignore-removal | [--update | -u]]
		[--intent-to-add | -N] [--refresh] [--ignore-errors] [--ignore-missing]
		[--chmod=(+|-)x] [--] [<pathspec>...]

DESCRIPTION

This command updates the index using the current content found in the working tree, to prepare the content staged for the next commit. It typically adds the current content of existing paths as a whole, but with some options it can also be used to add content with only part of the changes made to the working tree files applied, or remove paths that do not exist in the working tree anymore.

The "index" holds a snapshot of the content of the working tree, and it is this snapshot that is taken as the contents of the next commit. Thus after making any changes to the working tree, and before running the commit command, you must use the add command to add any new or modified files to the index.

This command can be performed multiple times before a commit. It only adds the content of the specified file(s) at the time the add command is run; if you want subsequent changes included in the next commit, then you must run git add again to add the new content to the index.

The git status command can be used to obtain a summary of which files have changes that are staged for the next commit.

The git add command will not add ignored files by default. If any ignored files were explicitly specified on the command line, git add will fail with a list of ignored files. Ignored files reached by directory recursion or filename globbing performed by Git (quote your globs before the shell) will be silently ignored. The git add command can be used to add ignored files with the -f (force) option.

Please see git-commit(1) for alternative ways to add content to a commit.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func All

func All(g *types.Cmd)

All Update the index not only where the working tree has a file matching <pathspec> but also where the index already has an entry. This adds, modifies, and removes index entries to match the working tree. If no <pathspec> is given when -A option is used, all files in the entire working tree are updated (old versions of Git used to limit the update to the current directory and its subdirectories). -A, --all, --no-ignore-removal

func Chmod

func Chmod(value string) func(*types.Cmd)

Chmod Override the executable bit of the added files. The executable bit is only changed in the index, the files on disk are left unchanged. --chmod=(+|-)x

func DryRun

func DryRun(g *types.Cmd)

DryRun Don't actually add the file(s), just show if they exist and/or will be ignored. -n, --dry-run

func Edit

func Edit(g *types.Cmd)

Edit Open the diff vs. the index in an editor and let the user edit it. After the editor was closed, adjust the hunk headers and apply the patch to the index. The intent of this option is to pick and choose lines of the patch to apply, or even to modify the contents of lines to be staged. This can be quicker and more flexible than using the interactive hunk selector. However, it is easy to confuse oneself and create a patch that does not apply to the index. See EDITING PATCHES below. -e, --edit

func Force

func Force(g *types.Cmd)

Force Allow adding otherwise ignored files. -f, --force

func HyphenHyphen

func HyphenHyphen(g *types.Cmd)

HyphenHyphen add `--` This option can be used to separate command-line options from the list of files, (useful when filenames might be mistaken for command-line options).

func IgnoreErrors

func IgnoreErrors(g *types.Cmd)

IgnoreErrors If some files could not be added because of errors indexing them, do not abort the operation, but continue adding the others. The command shall still exit with non-zero status. The configuration variable add.ignoreErrors can be set to true to make this the default behaviour. --ignore-errors

func IgnoreMissing

func IgnoreMissing(g *types.Cmd)

IgnoreMissing This option can only be used together with --dry-run. By using this option the user can check if any of the given files would be ignored, no matter if they are already present in the work tree or not. --ignore-missing

func IntentToAdd

func IntentToAdd(g *types.Cmd)

IntentToAdd Record only the fact that the path will be added later. An entry for the path is placed in the index with no content. This is useful for, among other things, showing the unstaged content of such files with git diff and committing them with git commit -a. -N, --intent-to-add

func Interactive

func Interactive(g *types.Cmd)

Interactive Add modified contents in the working tree interactively to the index. Optional path arguments may be supplied to limit operation to a subset of the working tree. See 'Interactive mode' for details. -i, --interactive

func NoAll

func NoAll(g *types.Cmd)

NoAll Update the index by adding new files that are unknown to the index and files modified in the working tree, but ignore files that have been removed from the working tree. This option is a no-op when no <pathspec> is used. This option is primarily to help users who are used to older versions of Git, whose 'git add <pathspec>...' was a synonym for 'git add --no-all <pathspec>...', i.e. ignored removed files. --no-all, --ignore-removal

func Patch

func Patch(g *types.Cmd)

Patch Interactively choose hunks of patch between the index and the work tree and add them to the index. This gives the user a chance to review the difference before adding modified contents to the index. This effectively runs add --interactive, but bypasses the initial command menu and directly jumps to the patch subcommand. See “Interactive mode” for details. -p, --patch

func PathSpec

func PathSpec(paths ...string) func(*types.Cmd)

PathSpec [<pathspec>...] Files to add content from. Fileglobs (e.g. *.c) can be given to add all matching files. Also a leading directory name (e.g. dir to add dir/file1 and dir/file2) can be given to update the index to match the current state of the directory as a whole (e.g. specifying dir will record not just a file dir/file1 modified in the working tree, a file dir/file2 added to the working tree, but also a file dir/file3 removed from the working tree.

func Refresh

func Refresh(g *types.Cmd)

Refresh Don't add the file(s), but only refresh their stat() information in the index. --refresh

func Update

func Update(g *types.Cmd)

Update Update the index just where it already has an entry matching <pathspec>. This removes as well as modifies index entries to match the working tree, but adds no new files. If no <pathspec> is given when -u option is used, all tracked files in the entire working tree are updated (old versions of Git used to limit the update to the current directory and its subdirectories). -u, --update

func Verbose

func Verbose(g *types.Cmd)

Verbose Be verbose. -v, --verbose

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL