Skip to content

Commit

Permalink
Merge pull request #807 from jhlegarreta/ImproveGitHelpSection
Browse files Browse the repository at this point in the history
DOC: Improve explanation about getting `git` help
  • Loading branch information
kekoziar committed Jul 2, 2021
2 parents cd0ddd6 + 9a5a1e9 commit acbe945
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion _episodes/02-setup.md
Expand Up @@ -162,7 +162,9 @@ same commands to choose another editor or update your email address.

> ## Git Help and Manual
>
> Always remember that if you forget a `git` command, you can access the list of commands by using `-h` and access the Git manual by using `--help` :
> Always remember that if you forget the subcommands or options of a `git` command, you can access the
> relevant list of options typing `git <command> -h` or access the corresponding Git manual by typing
> `git <command> --help`, e.g.:
>
> ~~~
> $ git config -h
Expand All @@ -172,6 +174,13 @@ same commands to choose another editor or update your email address.
>
> While viewing the manual, remember the `:` is a prompt waiting for commands and you can press <kbd>Q</kbd> to exit the manual.
>
> More generally, you can get the list of available `git` commands and further resources of the Git manual typing:
>
> ~~~
> $ git help
> ~~~
> {: .language-bash}
>
{: .callout}

[git-privacy]: https://help.github.com/articles/keeping-your-email-address-private/

0 comments on commit acbe945

Please sign in to comment.