git: change docs for git_main_branch

Also remove unnecesary dramatic remark
This commit is contained in:
Marc Cornellà 2020-07-11 20:18:05 +02:00
parent 55a98fc06d
commit 83f6194929
2 changed files with 8 additions and 9 deletions

View File

@ -208,13 +208,13 @@ These are aliases that have been removed, renamed, or otherwise modified in a wa
### Current ### Current
| Command | Description | | Command | Description |
|:-----------------------|:-----------------------------------------------------------------------------| |:-----------------------|:---------------------------------------------------------------------------------------|
| `grename <old> <new>` | Rename `old` branch to `new`, including in origin remote | | `grename <old> <new>` | Rename `old` branch to `new`, including in origin remote |
| current_branch | Return the name of the current branch | | current_branch | Return the name of the current branch |
| git_current_user_name | Returns the `user.name` config value | | git_current_user_name | Returns the `user.name` config value |
| git_current_user_email | Returns the `user.email` config value | | git_current_user_email | Returns the `user.email` config value |
| git_main_branch | Returns the name of the main branch: `master` if it exists, `main` otherwise | | git_main_branch | Returns the name of the main branch: from origin or from local branches, else 'master' |
### Work in Progress (WIP) ### Work in Progress (WIP)

View File

@ -25,8 +25,7 @@ function work_in_progress() {
fi fi
} }
# Get the default 'main' branch # Get the default 'main' branch: from origin, from local branches, or else just 'master'
# Marc(2020-07-11): I hope to be able to remove this someday
function git_main_branch() { function git_main_branch() {
# Get default branch from the origin remote # Get default branch from the origin remote
local branch local branch