Skip to content

Commit 8587a4a

Browse files
committed
docs: Hyperlink to git-rebase docs for reference.
1 parent 091a7f6 commit 8587a4a

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/menu-items.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Status
44
This menu option is analogous to the [git status](https://git-scm.com/docs/git-status) command and prints the status of the repository to the output.
55

6+
67
## Settings
78
This option opens the GUI's settings page project specific git-source-control settings can be configured. This includes the settings that were configured when running:
89
```
@@ -13,57 +14,70 @@ This page also includes the mappings configurations.
1314

1415
Any changes made to the settings must be saved using the 'Save' button in order to take effect.
1516

17+
1618
## Launch Git UI
1719
This menu option opens the git-source-control GUI. From here commit messages can be written, files can be staged and committed, branches can be viewed.
1820

21+
1922
## Add
2023
This menu option is analogous to the [git add](https://git-scm.com/docs/git-add) command. It will perform 'git add' on the currently open file, adding it to the files that can be staged.
2124

25+
2226
## Remove
2327
This menu option will only appear if the currently open file has been already added using the 'Add' menu option. It undoes the effect of adding the file, similar to running [git reset](https://git-scm.com/docs/git-reset) on a specific file.
2428

29+
2530
## Push to remote branch
2631
This option pushes the commits in the branch to the remote repository. This exhibits the same behavior as the [git push](https://git-scm.com/docs/git-push) command.
2732

33+
2834
## Push to remote branch (force)
2935
This option forcibly pushes the commits in the branch to the remote repository. This is potentially destructive and may overwrite the commit history of the remote branch. This exhibits the same behavior as the [git push --force](https://git-scm.com/docs/git-push) command.
3036

37+
3138
## Fetch from remote
3239
This option first [fetches](https://git-scm.com/docs/git-fetch) the most recent version of the branch without merging that version into the local copy of the branch. It will then list all files modified between the current version and the remote version.
3340

3441
This also has the effect of refreshing the list of all remote branches and pruning any references that no longer exist in the remote. (see: [git fetch --prune](https://git-scm.com/docs/git-fetch#Documentation/git-fetch.txt---prune))
3542

43+
3644
## Pull changes from remote branch
3745
Much like the [git pull](https://git-scm.com/docs/git-pull) command, this menu option pulls the most recent version of the current branch from a remote source, merging the changes into the local copy.
3846

47+
3948
## Sync
4049
This option will synchronize the current branch checked out a local repo with the same branch in a remote repo. It encapsulates the pattern of fetching, pulling, committing, and pushing into one menu action.
4150
- If you are on the Default Merge Branch, then Sync only pulls the latest commits from the remote. Committing is disallowed on the Default Merge Branch.
4251
- If there is no defined remote repository, it will simply commit any uncommitted files.
43-
- If there is a Default Merge Branch defined, then sync attempts to perform a rebase onto the latest Default Merge Branch from the remote.
52+
- If there is a Default Merge Branch defined, then sync attempts to perform a [rebase](https://git-scm.com/docs/git-rebase) onto the latest Default Merge Branch from the remote.
4453
- If the rebase were to result in merge conflicts, then this action is aborted so the system is not left in an inconsistent state.
4554

46-
4755
The sync operation is only enabled in basic mode.
4856

57+
4958
## Create new branch
5059
This menu option creates a new branch in the repository for changes to be committed to. It also changes the current branch to be the created branch. This mimics the behavior of the [git checkout -b](https://git-scm.com/docs/git-checkout) command.
5160

5261
In basic mode, this option first checks out the Default Merge Branch (if defined) and pulls that branch from the remote before creating the new branch.
5362

63+
5464
## Check out an existing branch
5565
This option refreshes the local list of branches available in the upstream repository, and then changes the currently checked out branch to the provided branch. This mimics the behavior of the [git fetch --prune](https://git-scm.com/docs/git-fetch#Documentation/git-fetch.txt---prune) and [git checkout](https://git-scm.com/docs/git-checkout) commands.
5666

5767
If the desired branch does not exist in your local or in the remote, then you will receive the "Selected branch does not exist" error message.
5868

69+
5970
## Export all
6071
This option exports class files to the local file tree at the configured location.
6172

73+
6274
## Export all (force)
6375
This option exports all class files regardless of whether they're already up to date in the local file tree or not.
6476

77+
6578
## Import all
6679
This option imports the versions of the files that are found in the configured directory into the project. Files that are out of date or the same as the files in the project won't be imported.
6780

81+
6882
## Import all (force)
6983
This menu option behaves similarly to the regular import but forces the files to be imported regardless of whether the on-disk version is the same or older.

0 commit comments

Comments
 (0)