Matthew DeVore a378fee5b0 Documentation: add shell guidelines ...

Add the following guideline to Documentation/CodingGuidelines:

	Break overlong lines after "&&", "||", and "|", not before
	them; that way the command can continue to subsequent lines
	without backslash at the end.

And the following to t/README (since it is specific to writing tests):

	Pipes and $(git ...) should be avoided when they swallow exit
	codes of Git processes

Signed-off-by: Matthew DeVore <matvore@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

2018-10-07 08:51:17 +09:00

..

howto

t/helper: merge test-sha1 into test-tool

2018-03-27 08:45:47 -07:00

RelNotes

Git 2.19

2018-09-10 10:41:56 -07:00

technical

Merge branch 'tg/rerere-doc-updates'

2018-09-17 13:53:57 -07:00

.gitattributes

…

.gitignore

add a script to diff rendered documentation

2018-08-06 12:30:23 -07:00

asciidoc.conf

…

asciidoctor-extensions.rb

Documentation: implement linkgit macro for Asciidoctor

2017-01-31 12:18:18 -08:00

blame-options.txt

Merge branch 'bc/blame-doc-fix'

2017-02-24 10:48:08 -08:00

build-docdep.perl

…

cat-texi.perl

Documentation: remove unneeded argument in cat-texi.perl

2017-01-23 10:56:47 -08:00

cmd-list.perl

…

CodingGuidelines

Documentation: add shell guidelines

2018-10-07 08:51:17 +09:00

config.txt

Merge branch 'bp/checkout-new-branch-optim'

2018-09-20 14:51:43 -07:00

date-formats.txt

Merge branch 'lr/doc-fix-cet' into maint

2017-01-17 15:19:08 -08:00

diff-config.txt

generate-cmdlist.sh: collect config from all config.txt files

2018-08-21 11:28:11 -07:00

diff-format.txt

Documentation: improve description for core.quotePath

2017-03-02 11:40:51 -08:00

diff-generate-patch.txt

Documentation: improve description for core.quotePath

2017-03-02 11:40:51 -08:00

diff-options.txt

Merge branch 'es/diff-color-moved-fix'

2018-08-15 15:08:22 -07:00

doc-diff

Merge branch 'es/worktree-forced-ops-fix'

2018-09-17 13:53:59 -07:00

docbook-xsl.css

…

docbook.xsl

…

everyday.txto

…

fetch-options.txt

Merge branch 'ab/fetch-tags-noclobber'

2018-09-17 13:54:00 -07:00

fix-texi.perl

…

fmt-merge-msg-config.txt

…

git-add.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-am.txt

Merge branch 'nd/rebase-show-current-patch'

2018-03-06 14:54:02 -08:00

git-annotate.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-apply.txt

Merge branch 'nd/diff-apply-ita'

2018-06-25 13:22:36 -07:00

git-archimport.txt

docs/archimport: quote sourcecontrol.net reference

2017-04-20 22:05:38 -07:00

git-archive.txt

…

git-bisect-lk2009.txt

Documentation: spelling and grammar fixes

2018-06-22 14:26:23 -07:00

git-bisect.txt

Merge branch 'ak/bisect-doc-typofix'

2018-04-25 13:28:56 +09:00

git-blame.txt

diff: --indent-heuristic is no longer experimental

2017-11-02 14:51:24 +09:00

git-branch.txt

Merge branch 'jk/branch-l-1-repurpose'

2018-09-17 13:53:50 -07:00

git-bundle.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-cat-file.txt

cat-file: support "unordered" output for --batch-all-objects

2018-08-13 13:48:31 -07:00

git-check-attr.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-check-ignore.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-check-mailmap.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-check-ref-format.txt

Doc/check-ref-format: clarify information about @{-N} syntax

2017-12-19 10:00:45 -08:00

git-checkout-index.txt

…

git-checkout.txt

checkout & worktree: introduce checkout.defaultRemote

2018-06-11 09:41:02 -07:00

git-cherry-pick.txt

…

git-cherry.txt

…

git-citool.txt

…

git-clean.txt

…

git-clone.txt

Merge branch 'nd/doc-header'

2018-05-23 14:38:22 +09:00

git-column.txt

…

git-commit-graph.txt

commit-graph: add '--reachable' option

2018-06-27 10:29:10 -07:00

git-commit-tree.txt

…

git-commit.txt

commit: add support for --fixup <commit> -m"<extra message>"

2017-12-22 13:10:24 -08:00

git-config.txt

Merge branch 'sb/config-write-fix'

2018-08-20 12:41:32 -07:00

git-count-objects.txt

…

git-credential-cache--daemon.txt

…

git-credential-cache.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-credential-store.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-credential.txt

…

git-cvsexportcommit.txt

…

git-cvsimport.txt

…

git-cvsserver.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-daemon.txt

daemon: add --log-destination=(stderr|syslog|none)

2018-02-05 10:30:44 -08:00

git-describe.txt

builtin/describe.c: describe a blob

2017-12-19 11:17:16 -08:00

git-diff-files.txt

…

git-diff-index.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-diff-tree.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-diff.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-difftool.txt

Document the --no-gui option in difftool

2017-02-08 13:30:28 -08:00

git-fast-export.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-fast-import.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-fetch-pack.txt

Documentation: fix several one-character-off spelling errors

2018-04-09 14:15:02 +09:00

git-fetch.txt

fetch: make the --prune-tags work with <url>

2018-02-09 13:10:13 -08:00

git-filter-branch.txt

Merge branch 'nd/doc-header'

2018-05-23 14:38:22 +09:00

git-fmt-merge-msg.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-for-each-ref.txt

Merge branch 'jk/ui-color-always-to-auto'

2018-08-15 15:08:19 -07:00

git-format-patch.txt

format-patch: allow --range-diff to apply to a lone-patch

2018-08-14 14:27:05 -07:00

git-fsck-objects.txt

…

git-fsck.txt

fsck: verify commit-graph

2018-06-27 10:29:10 -07:00

git-gc.txt

gc: automatically write commit-graph files

2018-06-27 10:29:10 -07:00

git-get-tar-commit-id.txt

…

git-grep.txt

grep.c: teach 'git grep --only-matching'

2018-07-09 14:15:28 -07:00

git-gui.txt

doc: git-gui browser does not default to HEAD

2017-01-13 12:23:28 -08:00

git-hash-object.txt

…

git-help.txt

help: add --config to list all available config

2018-05-29 14:51:28 +09:00

git-http-backend.txt

…

git-http-fetch.txt

http-fetch: make -a standard behaviour

2018-04-24 10:55:02 +09:00

git-http-push.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-imap-send.txt

Documentation: spelling and grammar fixes

2018-06-22 14:26:23 -07:00

git-index-pack.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-init-db.txt

…

git-init.txt

init: document dotfiles exclusion on template copy

2017-02-17 15:57:21 -08:00

git-instaweb.txt

…

git-interpret-trailers.txt

Merge branch 'jk/trailer-fixes'

2018-09-17 13:53:54 -07:00

git-log.txt

git-[short]log.txt: unify quoted standalone --

2018-04-18 12:49:26 +09:00

git-ls-files.txt

Merge branch 'ah/misc-doc-updates'

2018-05-23 14:38:23 +09:00

git-ls-remote.txt

Merge branch 'bw/server-options'

2018-05-23 14:38:15 +09:00

git-ls-tree.txt

Documentation: improve description for core.quotePath

2017-03-02 11:40:51 -08:00

git-mailinfo.txt

…

git-mailsplit.txt

…

git-merge-base.txt

merge-base --fork-point doc: clarify the example and failure modes

2017-11-09 12:28:30 +09:00

git-merge-file.txt

…

git-merge-index.txt

…

git-merge-one-file.txt

…

git-merge-tree.txt

…

git-merge.txt

Merge branch 'en/dirty-merge-fixes'

2018-08-02 15:30:45 -07:00

git-mergetool--lib.txt

…

git-mergetool.txt

…

git-mktag.txt

…

git-mktree.txt

Documentation: normalize spelling of 'normalised'

2018-04-09 14:15:07 +09:00

git-multi-pack-index.txt

multi-pack-index: add 'write' verb

2018-07-20 11:27:28 -07:00

git-mv.txt

…

git-name-rev.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-notes.txt

Documentation: spelling and grammar fixes

2018-06-22 14:26:23 -07:00

git-p4.txt

git-p4: add the p4-pre-submit hook

2018-08-01 13:37:18 -07:00

git-pack-objects.txt

pack-objects: add delta-islands support

2018-08-16 10:51:17 -07:00

git-pack-redundant.txt

…

git-pack-refs.txt

…

git-parse-remote.txt

…

git-patch-id.txt

doc: remove unsupported parameter from patch-id

2017-07-28 14:41:32 -07:00

git-prune-packed.txt

…

git-prune.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-pull.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-push.txt

push doc: add spacing between two words

2018-09-19 12:43:50 -07:00

git-quiltimport.txt

…

git-range-diff.txt

range-diff: use dim/bold cues to improve dual color mode

2018-08-13 10:44:52 -07:00

git-read-tree.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-rebase.txt

Merge branch 'js/rebase-merge-octopus'

2018-08-02 15:30:44 -07:00

git-receive-pack.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-reflog.txt

doc: add missing "-n" (dry-run) option to reflog man page

2017-11-22 12:24:47 +09:00

git-remote-ext.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-remote-fd.txt

…

git-remote-helpers.txto

…

git-remote-testgit.txt

…

git-remote.txt

Merge branch 'nd/remote-update-doc'

2018-06-04 21:39:49 +09:00

git-repack.txt

Merge branch 'cc/delta-islands'

2018-09-17 13:53:55 -07:00

git-replace.txt

replace: introduce --convert-graft-file

2018-04-30 11:12:30 +09:00

git-request-pull.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-rerere.txt

rerere: add note about files with existing conflict markers

2018-08-29 09:03:29 -07:00

git-reset.txt

Spelling fixes

2017-06-27 10:35:49 -07:00

git-rev-list.txt

rev-list: add list-objects filtering support

2017-11-22 14:11:57 +09:00

git-rev-parse.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-revert.txt

…

git-rm.txt

treewide: correct several "up-to-date" to "up to date"

2017-08-23 12:17:22 -07:00

git-send-email.txt

docs: correct RFC specifying email line length

2018-07-09 10:55:12 -07:00

git-send-pack.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-sh-i18n--envsubst.txt

…

git-sh-i18n.txt

…

git-sh-setup.txt

…

git-shell.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-shortlog.txt

git-[short]log.txt: unify quoted standalone --

2018-04-18 12:49:26 +09:00

git-show-branch.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-show-index.txt

show-index: update documentation for index v2

2018-05-29 00:28:22 +09:00

git-show-ref.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-show.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-stage.txt

…

git-stash.txt

git-stash.txt: remove extra square bracket

2018-03-27 19:09:13 -07:00

git-status.txt

Documentation: spelling and grammar fixes

2018-06-22 14:26:23 -07:00

git-stripspace.txt

…

git-submodule.txt

Merge branch 'pc/submodule-helper-foreach'

2018-06-25 13:22:35 -07:00

git-svn.txt

Documentation: spelling and grammar fixes

2018-06-22 14:26:23 -07:00

git-symbolic-ref.txt

…

git-tag.txt

Merge branch 'jk/ui-color-always-to-auto'

2018-08-15 15:08:19 -07:00

git-tools.txt

doc: replace or.cz gitwiki link with git.wiki.kernel.org

2017-04-20 22:05:37 -07:00

git-unpack-file.txt

…

git-unpack-objects.txt

…

git-update-index.txt

Merge branch 'jc/update-index-doc'

2018-08-20 11:33:50 -07:00

git-update-ref.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-update-server-info.txt

…

git-upload-archive.txt

…

git-upload-pack.txt

…

git-var.txt

doc: keep first level section header in upper case

2018-05-02 17:03:33 +09:00

git-verify-commit.txt

…

git-verify-pack.txt

…

git-verify-tag.txt

builtin/verify-tag: add --format to verify-tag

2017-01-17 16:10:22 -08:00

git-web--browse.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

git-whatchanged.txt

…

git-worktree.txt

worktree: teach 'remove' to override lock when --force given twice

2018-08-30 09:28:02 -07:00

git-write-tree.txt

…

git.txt

Documentation/git.txt: clarify that GIT_TRACE=/path appends

2018-09-04 10:28:40 -07:00

gitattributes.txt

Merge branch 'nd/command-list'

2018-06-01 15:06:37 +09:00

gitcli.txt

Use proper syntax for replaceables in command docs

2018-05-25 17:16:47 +09:00

gitcore-tutorial.txt

treewide: correct several "up-to-date" to "up to date"

2017-08-23 12:17:22 -07:00

gitcredentials.txt

credential doc: make multiple-helper behavior more prominent

2017-05-02 10:58:06 +09:00

gitcvs-migration.txt

Merge branch 'sb/doc-unify-bottom'

2017-02-15 12:54:20 -08:00

gitdiffcore.txt

docs/diffcore: unquote "Complete Rewrites" in headers

2017-02-28 11:34:38 -08:00

giteveryday.txt

Documentation: spelling and grammar fixes

2018-06-22 14:26:23 -07:00

gitglossary.txt

Documentation: unify bottom "part of git suite" lines

2017-02-09 15:14:01 -08:00

githooks.txt

git-p4: add the p4-pre-submit hook

2018-08-01 13:37:18 -07:00

gitignore.txt

gitignore.txt: clarify default core.excludesfile path

2018-06-27 12:17:16 -07:00

gitk.txt

doc: convert [\--] to [--]

2018-04-18 12:49:26 +09:00

gitmodules.txt

help: use command-list.txt for the source of guides

2018-05-21 13:23:14 +09:00

gitnamespaces.txt

doc: mention transfer data leaks in more places

2016-11-14 11:23:07 -08:00

gitremote-helpers.txt

Merge branch 'bw/protocol-v2'

2018-05-08 15:59:16 +09:00

gitrepository-layout.txt

worktree: delete dead code

2018-03-15 12:37:47 -07:00

gitrevisions.txt

push doc: correct lies about how push refspecs work

2018-08-31 14:04:06 -07:00

gitsubmodules.txt

Documentation: spelling and grammar fixes

2018-06-22 14:26:23 -07:00

gittutorial-2.txt

Documentation: unify bottom "part of git suite" lines

2017-02-09 15:14:01 -08:00

gittutorial.txt

treewide: correct several "up-to-date" to "up to date"

2017-08-23 12:17:22 -07:00

gitweb.conf.txt

doc: use https links to avoid http redirect

2017-04-20 22:05:37 -07:00

gitweb.txt

doc: use https links to Wikipedia to avoid http redirects

2017-05-15 13:04:54 +09:00

gitworkflows.txt

Merge branch 'km/doc-workflows-typofix'

2018-06-18 10:18:42 -07:00

glossary-content.txt

Documentation: spelling and grammar fixes

2018-06-22 14:26:23 -07:00

howto-index.sh

…

i18n.txt

doc: camelCase the i18n config variables to improve readability

2017-07-17 15:11:26 -07:00

install-doc-quick.sh

install-doc-quick: allow specifying what ref to install

2017-12-12 16:49:40 -08:00

install-webdoc.sh

…

line-range-format.txt

…

lint-gitlink.perl

…

mailmap.txt

…

Makefile

Merge branch 'ts/doc-build-manpage-xsl-quietly'

2018-09-17 13:53:49 -07:00

manpage-1.72.xsl

…

manpage-base-url.xsl.in

…

manpage-base.xsl

…

manpage-bold-literal.xsl

…

manpage-normal.xsl

…

manpage-quote-apos.xsl

…

manpage-suppress-sp.xsl

…

merge-config.txt

merge: add merge.renames config setting

2018-05-08 16:19:41 +09:00

merge-options.txt

merge: allow fast-forward when merging a tracked tag

2018-02-16 11:22:43 -08:00

merge-strategies.txt

merge: add merge.renames config setting

2018-05-08 16:19:41 +09:00

pretty-formats.txt

Merge branch 'mk/doc-pretty-fill'

2018-03-08 12:36:29 -08:00

pretty-options.txt

…

pull-fetch-param.txt

fetch doc: correct grammar in --force docs

2018-09-20 09:40:03 -07:00

rebase-config.txt

rebase -i: learn to abbreviate command names

2017-12-05 10:20:51 -08:00

rev-list-options.txt

Merge branch 'jh/fsck-promisors'

2018-02-13 13:39:03 -08:00

revisions.txt

Merge branch 'wc/find-commit-with-pattern-on-detached-head'

2018-07-24 14:50:49 -07:00

sequencer.txt

…

SubmittingPatches

SubmittingPatches: mention doc-diff

2018-08-21 12:54:33 -07:00

texi.xsl

Documentation: add XSLT to fix DocBook for Texinfo

2017-01-23 10:56:53 -08:00

transfer-data-leaks.txt

doc: mention transfer data leaks in more places

2016-11-14 11:23:07 -08:00

urls-remotes.txt

…

urls.txt

…

user-manual.conf

…

user-manual.txt

checkout: describe_detached_head: remove ellipsis after committish

2017-12-06 07:32:40 -08:00