All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] README.md: format CLI commands with code syntax
@ 2016-05-30  3:08 Benjamin Dopplinger
  2016-05-30  6:05 ` Matthieu Moy
  0 siblings, 1 reply; 3+ messages in thread
From: Benjamin Dopplinger @ 2016-05-30  3:08 UTC (permalink / raw)
  To: git

CLI commands which are mentioned in the readme are now formatted with
the Markdown code syntax to make the documentation more readable.

Signed-off-by: Benjamin Dopplinger <b.dopplinger@gmail.com>
---
 README.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 2087748..bd8a918 100644
--- a/README.md
+++ b/README.md
@@ -17,14 +17,14 @@ including full documentation and Git related tools.
 
 See [Documentation/gittutorial.txt][] to get started, then see
 [Documentation/giteveryday.txt][] for a useful minimum set of commands, and
-Documentation/git-*commandname*.txt for documentation of each command.
+Documentation/git-<commandname>.txt for documentation of each command.
 If git has been correctly installed, then the tutorial can also be
-read with "man gittutorial" or "git help tutorial", and the
-documentation of each command with "man git-*commandname*" or "git help
-*commandname*".
+read with `man gittutorial` or `git help tutorial`, and the
+documentation of each command with `man git-<commandname>` or `git help
+<commandname>`.
 
 CVS users may also want to read [Documentation/gitcvs-migration.txt][]
-("man gitcvs-migration" or "git help cvs-migration" if git is
+(`man gitcvs-migration` or `git help cvs-migration` if git is
 installed).
 
 The user discussion and development of Git take place on the Git

--
https://github.com/git/git/pull/247

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] README.md: format CLI commands with code syntax
  2016-05-30  3:08 [PATCH] README.md: format CLI commands with code syntax Benjamin Dopplinger
@ 2016-05-30  6:05 ` Matthieu Moy
  2016-05-31 15:54   ` Junio C Hamano
  0 siblings, 1 reply; 3+ messages in thread
From: Matthieu Moy @ 2016-05-30  6:05 UTC (permalink / raw)
  To: Benjamin Dopplinger; +Cc: git

Benjamin Dopplinger <b.dopplinger@gmail.com> writes:

> CLI commands which are mentioned in the readme are now formatted with
> the Markdown code syntax to make the documentation more readable.
>
> Signed-off-by: Benjamin Dopplinger <b.dopplinger@gmail.com>
> ---
>  README.md | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)

Looks good to me, thanks.

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] README.md: format CLI commands with code syntax
  2016-05-30  6:05 ` Matthieu Moy
@ 2016-05-31 15:54   ` Junio C Hamano
  0 siblings, 0 replies; 3+ messages in thread
From: Junio C Hamano @ 2016-05-31 15:54 UTC (permalink / raw)
  To: Matthieu Moy; +Cc: Benjamin Dopplinger, git

Thanks, both..

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2016-05-31 15:54 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-05-30  3:08 [PATCH] README.md: format CLI commands with code syntax Benjamin Dopplinger
2016-05-30  6:05 ` Matthieu Moy
2016-05-31 15:54   ` Junio C Hamano

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.