<feed xmlns='http://www.w3.org/2005/Atom'>
<title>git/Documentation/git-help.txt, branch v2.22.2</title>
<subtitle>Mirror of https://git.kernel.org/pub/scm/git/git.git/
</subtitle>
<id>https://git.shady.money/git/atom?h=v2.22.2</id>
<link rel='self' href='https://git.shady.money/git/atom?h=v2.22.2'/>
<link rel='alternate' type='text/html' href='https://git.shady.money/git/'/>
<updated>2019-03-13T02:14:22Z</updated>
<entry>
<title>doc: format pathnames and URLs as monospace.</title>
<updated>2019-03-13T02:14:22Z</updated>
<author>
<name>Corentin BOMPARD</name>
<email>corentin.bompard@etu.univ-lyon1.fr</email>
</author>
<published>2019-03-06T13:04:46Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/git/commit/?id=68ed71b53cf7c58343306566fa6d527cb5fced41'/>
<id>urn:sha1:68ed71b53cf7c58343306566fa6d527cb5fced41</id>
<content type='text'>
Applying CodingGuidelines about monospace on pathnames and URLs.

See Documentation/CodingGuidelines.txt for more information.

Signed-off-by: Corentin BOMPARD &lt;corentin.bompard@etu.univ-lyon1.fr&gt;
Signed-off-by: Nathan BERBEZIER &lt;nathan.berbezier@etu.univ-lyon1.fr&gt;
Signed-off-by: Pablo CHABANNE &lt;pablo.chabanne@etu.univ-lyon1.fr&gt;
Signed-off-by: Matthieu MOY &lt;matthieu.moy@univ-lyon1.fr&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
</content>
</entry>
<entry>
<title>doc: tidy asciidoc style</title>
<updated>2019-01-23T19:37:29Z</updated>
<author>
<name>Jean-Noël Avila</name>
<email>jn.avila@free.fr</email>
</author>
<published>2019-01-22T20:16:35Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/git/commit/?id=ba170517be039a04b1914ebe9b492d4139c707df'/>
<id>urn:sha1:ba170517be039a04b1914ebe9b492d4139c707df</id>
<content type='text'>
This mainly refers to enforcing indentation on additional lines of
items of lists.

Signed-off-by: Jean-Noël Avila &lt;jn.avila@free.fr&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
</content>
</entry>
<entry>
<title>Merge branch 'rv/alias-help'</title>
<updated>2018-10-26T05:22:13Z</updated>
<author>
<name>Junio C Hamano</name>
<email>gitster@pobox.com</email>
</author>
<published>2018-10-26T05:22:13Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/git/commit/?id=7752999cd6bbe1aff4e34f83ed078ffffc232667'/>
<id>urn:sha1:7752999cd6bbe1aff4e34f83ed078ffffc232667</id>
<content type='text'>
"git cmd --help" when "cmd" is aliased used to only say "cmd is
aliased to ...".  Now it shows that to the standard error stream
and runs "git $cmd --help" where $cmd is the first word of the
alias expansion.

This could be misleading for those who alias a command with options
(e.g. with "[alias] cpn = cherry-pick -n", "git cpn --help" would
show the manual of "cherry-pick", and the reader would not be told
to pay close attention to the part that describes the "--no-commit"
option until closing the pager that showed the contents of the
manual, if the pager is configured to restore the original screen,
or would not be told at all, if the pager simply makes the message
on the standard error scroll away.

* rv/alias-help:
  git-help.txt: document "git help cmd" vs "git cmd --help" for aliases
  git.c: handle_alias: prepend alias info when first argument is -h
  help: redirect to aliased commands for "git cmd --help"
</content>
</entry>
<entry>
<title>git-help.txt: document "git help cmd" vs "git cmd --help" for aliases</title>
<updated>2018-10-11T01:21:44Z</updated>
<author>
<name>Rasmus Villemoes</name>
<email>rv@rasmusvillemoes.dk</email>
</author>
<published>2018-10-09T11:59:09Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/git/commit/?id=912104770d1b3b009a58e95ae57f6db65791b031'/>
<id>urn:sha1:912104770d1b3b009a58e95ae57f6db65791b031</id>
<content type='text'>
This documents the existing behaviour of "git help cmd" when cmd is an
alias, as well as providing a hint to use the "git cmd --help" form to
be taken directly to the man page for the aliased command.

Signed-off-by: Rasmus Villemoes &lt;rv@rasmusvillemoes.dk&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
</content>
</entry>
<entry>
<title>help -a: improve and make --verbose default</title>
<updated>2018-10-04T04:23:51Z</updated>
<author>
<name>Nguyễn Thái Ngọc Duy</name>
<email>pclouds@gmail.com</email>
</author>
<published>2018-09-29T06:08:14Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/git/commit/?id=26c7d0678324d99b56d3044acfdfab57ee670af4'/>
<id>urn:sha1:26c7d0678324d99b56d3044acfdfab57ee670af4</id>
<content type='text'>
When you type "git help" (or just "git") you are greeted with a list
with commonly used commands and their short description and are
suggested to use "git help -a" or "git help -g" for more details.

"git help -av" would be more friendly and inline with what is shown
with "git help" since it shows list of commands with description as
well, and commands are properly grouped.

"help -av" does not show everything "help -a" shows though. Add
external command section in "help -av" for this. While at there, add a
section for aliases as well (until now aliases have no UI, just "git
config").

Signed-off-by: Nguyễn Thái Ngọc Duy &lt;pclouds@gmail.com&gt;
Reviewed-by: Taylor Blau &lt;me@ttaylorr.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
</content>
</entry>
<entry>
<title>help: add --config to list all available config</title>
<updated>2018-05-29T05:51:28Z</updated>
<author>
<name>Nguyễn Thái Ngọc Duy</name>
<email>pclouds@gmail.com</email>
</author>
<published>2018-05-26T13:55:24Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/git/commit/?id=3ac68a93fd2b984e2a7e570217d2646a208ffcc3'/>
<id>urn:sha1:3ac68a93fd2b984e2a7e570217d2646a208ffcc3</id>
<content type='text'>
Sometimes it helps to list all available config vars so the user can
search for something they want. The config man page can also be used
but it's harder to search if you want to focus on the variable name,
for example.

This is not the best way to collect the available config since it's
not precise. Ideally we should have a centralized list of config in C
code (pretty much like 'struct option'), but that's a lot more work.
This will do for now.

Signed-off-by: Nguyễn Thái Ngọc Duy &lt;pclouds@gmail.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
</content>
</entry>
<entry>
<title>help: add "-a --verbose" to list all commands with synopsis</title>
<updated>2018-05-21T04:23:14Z</updated>
<author>
<name>Nguyễn Thái Ngọc Duy</name>
<email>pclouds@gmail.com</email>
</author>
<published>2018-05-20T18:40:01Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/git/commit/?id=63eae83f8f301a1052cdde254b84f5da00e7b9b6'/>
<id>urn:sha1:63eae83f8f301a1052cdde254b84f5da00e7b9b6</id>
<content type='text'>
This lists all recognized commands [1] by category. The group order
follows closely git.txt.

[1] We may actually show commands that are not built (e.g. if you set
NO_PERL you don't have git-instaweb but it's still listed here). I
ignore the problem because on Linux a git package could be split
anyway. The "git-core" package may not contain git-instaweb even if
it's built because it may end up in a separate package. We can't know
anyway.

Signed-off-by: Nguyễn Thái Ngọc Duy &lt;pclouds@gmail.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
</content>
</entry>
<entry>
<title>doc: typeset long command-line options as literal</title>
<updated>2016-06-28T15:36:45Z</updated>
<author>
<name>Matthieu Moy</name>
<email>Matthieu.Moy@imag.fr</email>
</author>
<published>2016-06-28T11:40:11Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/git/commit/?id=bcf9626a71a0d90be65acc265ad0ec488d95d6ed'/>
<id>urn:sha1:bcf9626a71a0d90be65acc265ad0ec488d95d6ed</id>
<content type='text'>
Similarly to the previous commit, use backquotes instead of
forward-quotes, for long options.

This was obtained with:

  perl -pi -e "s/'(--[a-z][a-z=&lt;&gt;-]*)'/\`\$1\`/g" *.txt

and manual tweak to remove false positive in ascii-art (o'--o'--o' to
describe rewritten history).

Signed-off-by: Matthieu Moy &lt;Matthieu.Moy@imag.fr&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
</content>
</entry>
<entry>
<title>doc: typeset short command-line options as literal</title>
<updated>2016-06-28T15:20:52Z</updated>
<author>
<name>Matthieu Moy</name>
<email>Matthieu.Moy@imag.fr</email>
</author>
<published>2016-06-28T11:40:10Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/git/commit/?id=23f8239bbe0a893bd8754a03e9d4fda62804ac14'/>
<id>urn:sha1:23f8239bbe0a893bd8754a03e9d4fda62804ac14</id>
<content type='text'>
It was common in our documentation to surround short option names with
forward quotes, which renders as italic in HTML. Instead, use backquotes
which renders as monospace. This is one more step toward conformance to
Documentation/CodingGuidelines.

This was obtained with:

  perl -pi -e "s/'(-[a-z])'/\`\$1\`/g" *.txt

Signed-off-by: Matthieu Moy &lt;Matthieu.Moy@imag.fr&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
</content>
</entry>
<entry>
<title>doc: change configuration variables format</title>
<updated>2016-06-08T19:04:55Z</updated>
<author>
<name>Tom Russello</name>
<email>tom.russello@grenoble-inp.org</email>
</author>
<published>2016-06-08T17:23:16Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/git/commit/?id=ae9f6311e9c15d7968c2d03eab6e929e9c9d5f42'/>
<id>urn:sha1:ae9f6311e9c15d7968c2d03eab6e929e9c9d5f42</id>
<content type='text'>
This change configuration variables that where in italic style
to monospace font according to the guideline. It was obtained with

	grep '[[:alpha:]]*\.[[:alpha:]]*::$' config.txt | \
	sed -e 's/::$//' -e 's/\./\\\\./' | \
	xargs -iP perl -pi -e "s/\'P\'/\`P\`/g" ./*.txt

Signed-off-by: Tom Russello &lt;tom.russello@grenoble-inp.org&gt;
Signed-off-by: Erwan Mathoniere &lt;erwan.mathoniere@grenoble-inp.org&gt;
Signed-off-by: Samuel Groot &lt;samuel.groot@grenoble-inp.org&gt;
Signed-off-by: Matthieu Moy &lt;matthieu.moy@grenoble-inp.fr&gt;
Reviewed-by: Matthieu Moy &lt;Matthieu.Moy@imag.fr&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
</content>
</entry>
</feed>
