Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Improve explanation about getting git help #807

Merged
merged 2 commits into from Jul 2, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 10 additions & 1 deletion _episodes/02-setup.md
Expand Up @@ -141,7 +141,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 @@ -151,6 +153,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/