docs: example of using config vars to sort git branch

[iloveitaly]

Check list

• I have performed a self-review of my code
• I have commented my code in hard-to-understand areas
• I have made corresponding changes to the documentation

Description

Docs with an example of using a config var to customize gcb

Type of change

• Bug fix
• New feature
• Refactor
• Breaking change
• Documentation change

Test environment

• Shell
  • bash
  • zsh
  • fish
• OS
  • Linux
  • Mac OS X
  • Windows
  • Others:

[sandr01d]

Thanks for the contribution @iloveitaly! Having an example here makes sense to me. Requesting a review from @cjappl, since you reviewed #307, but I think we can merge this soon.

[cjappl]

Great. Thanks for the contribution! Will merge

[carlfriedrich]

I think there's a typo here. Shouldn't it be

FORGIT_CHECKOUT_BRANCH_GIT_OPTS

instead of

FORGIT_CHECKOUT_BRANCH_BRANCH_GIT_OPTS

?

[sandr01d]

I think there's a typo here. Shouldn't it be

FORGIT_CHECKOUT_BRANCH_GIT_OPTS

instead of

FORGIT_CHECKOUT_BRANCH_BRANCH_GIT_OPTS

?

Both exist, see

forgit/bin/git-forgit

Line 456 in f1ac9e3

cmd="git branch --color=always ${FORGIT_CHECKOUT_BRANCH_BRANCH_GIT_OPTS:---all} | LC_ALL=C sort -k1.1,1.1 -rs"

FORGIT_CHECKOUT_BRANCH_BRANCH_GIT_OPTS is passed the command that retrieves the branches, FORGIT_CHECKOUT_BRANCH_GIT_OPTS is passed to the git checkout command.

[carlfriedrich]

@sandr01d Ah, thanks for clarifying, and sorry for the noise! 🙈