git/Documentation at 049e64aa5024a9fa2fbe6116d413da1ffc7f497a - git

History

brian m. carlson 049e64aa50 Documentation: convert SubmittingPatches to AsciiDoc The SubmittingPatches document is often cited by outside parties as an example of good practices to follow, including logical, independent commits; patch sign-offs; and sending patches to a mailing list. Currently, people who want to cite a particular section tend to either refer to it by name and let the interested party search through the document to find it, or link to a given line number on GitHub and hope the file doesn't change. Instead, convert the document to AsciiDoc. Build it as part of the technical documentation, since it is likely of interest to the same group of people. Provide stable links to the sections which outside parties are likely to want to link to. Make some minor structural changes to organize it so that it can be formatted sanely. Since the makefile needs a .txt extension in order to build with the rest of the documentation, simply copy the file. Ignore the temporary file so it doesn't get checked in accidentally, and remove it as part of the clean process. Do this instead of renaming the file so that people who have already linked to the documentation (who we're trying to help) don't find their links broken. Avoid symlinking since Windows will not like that. This allows us to render the document as part of the website for the benefit of others who wish to link to it as well as providing a more nicely formatted display for our community and potential contributors. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>		7 years ago
..
RelNotes	Hopefully final batch before 2.15	7 years ago
howto	…
technical	Merge branch 'hn/string-list-doc'	7 years ago
.gitattributes	…
.gitignore	Documentation: convert SubmittingPatches to AsciiDoc	7 years ago
CodingGuidelines	…
Makefile	Documentation: convert SubmittingPatches to AsciiDoc	7 years ago
SubmittingPatches	Documentation: convert SubmittingPatches to AsciiDoc	7 years ago
asciidoc.conf	…
asciidoctor-extensions.rb	…
blame-options.txt	…
build-docdep.perl	…
cat-texi.perl	…
cmd-list.perl	…
config.txt	Merge branch 'jk/ref-filter-colors-fix'	7 years ago
date-formats.txt	…
diff-config.txt	doc: add missing values "none" and "default" for diff.wsErrorHighlight	8 years ago
diff-format.txt	…
diff-generate-patch.txt	…
diff-heuristic-options.txt	…
diff-options.txt	Merge branch 'jt/diff-color-move-fix'	8 years ago
docbook-xsl.css	…
docbook.xsl	…
everyday.txto	…
fetch-options.txt	…
fix-texi.perl	…
fmt-merge-msg-config.txt	…
git-add.txt	Merge branch 'mr/doc-negative-pathspec' into maint	7 years ago
git-am.txt	…
git-annotate.txt	…
git-apply.txt	treewide: correct several "up-to-date" to "up to date"	8 years ago
git-archimport.txt	…
git-archive.txt	…
git-bisect-lk2009.txt	…
git-bisect.txt	…
git-blame.txt	…
git-branch.txt	Merge branch 'jc/branch-force-doc-readability-fix'	7 years ago
git-bundle.txt	…
git-cat-file.txt	doc: fix minor typos (extra/duplicated words)	8 years ago
git-check-attr.txt	…
git-check-ignore.txt	…
git-check-mailmap.txt	…
git-check-ref-format.txt	…
git-checkout-index.txt	…
git-checkout.txt	Merge branch 'jc/doc-checkout' into maint	7 years ago
git-cherry-pick.txt	…
git-cherry.txt	…
git-citool.txt	…
git-clean.txt	…
git-clone.txt	…
git-column.txt	…
git-commit-tree.txt	…
git-commit.txt	doc: reformat the paragraph containing the 'cut-line'	8 years ago
git-config.txt	config doc: clarify "git config --path" example	7 years ago
git-count-objects.txt	…
git-credential-cache--daemon.txt	…
git-credential-cache.txt	…
git-credential-store.txt	…
git-credential.txt	…
git-cvsexportcommit.txt	…
git-cvsimport.txt	…
git-cvsserver.txt	treewide: correct several "up-to-date" to "up to date"	8 years ago
git-daemon.txt	…
git-describe.txt	describe: teach --match to handle branches and remotes	8 years ago
git-diff-files.txt	…
git-diff-index.txt	treewide: correct several "up-to-date" to "up to date"	8 years ago
git-diff-tree.txt	…
git-diff.txt	…
git-difftool.txt	…
git-fast-export.txt	…
git-fast-import.txt	…
git-fetch-pack.txt	…
git-fetch.txt	…
git-filter-branch.txt	Merge branch 'dg/filter-branch-filter-order-doc'	7 years ago
git-fmt-merge-msg.txt	…
git-for-each-ref.txt	Merge branch 'jk/ref-filter-colors-fix' into maint	7 years ago
git-format-patch.txt	format-patch: have progress option while generating patches	8 years ago
git-fsck-objects.txt	…
git-fsck.txt	…
git-gc.txt	…
git-get-tar-commit-id.txt	…
git-grep.txt	Merge branch 'mr/doc-negative-pathspec' into maint	7 years ago
git-gui.txt	…
git-hash-object.txt	…
git-help.txt	…
git-http-backend.txt	…
git-http-fetch.txt	…
git-http-push.txt	…
git-imap-send.txt	…
git-index-pack.txt	…
git-init-db.txt	…
git-init.txt	…
git-instaweb.txt	…
git-interpret-trailers.txt	Merge branch 'jk/trailers-parse'	8 years ago
git-log.txt	…
git-ls-files.txt	…
git-ls-remote.txt	…
git-ls-tree.txt	…
git-mailinfo.txt	…
git-mailsplit.txt	…
git-merge-base.txt	…
git-merge-file.txt	…
git-merge-index.txt	…
git-merge-one-file.txt	…
git-merge-tree.txt	…
git-merge.txt	Merge branch 'wk/merge-options-gpg-sign-doc'	7 years ago
git-mergetool--lib.txt	…
git-mergetool.txt	…
git-mktag.txt	…
git-mktree.txt	…
git-mv.txt	…
git-name-rev.txt	…
git-notes.txt	doc: fix minor typos (extra/duplicated words)	8 years ago
git-p4.txt	…
git-pack-objects.txt	Doc: clarify that pack-objects makes packs, plural	8 years ago
git-pack-redundant.txt	…
git-pack-refs.txt	…
git-parse-remote.txt	…
git-patch-id.txt	doc: remove unsupported parameter from patch-id	8 years ago
git-prune-packed.txt	…
git-prune.txt	…
git-pull.txt	Merge branch 'sb/pull-rebase-submodule'	8 years ago
git-push.txt	Merge branch 'ma/parse-maybe-bool'	8 years ago
git-quiltimport.txt	…
git-read-tree.txt	Merge branch 'jk/doc-read-tree-table-asciidoctor-fix' into maint	7 years ago
git-rebase.txt	Merge branch 'js/rebase-i-final'	7 years ago
git-receive-pack.txt	…
git-reflog.txt	…
git-remote-ext.txt	…
git-remote-fd.txt	…
git-remote-helpers.txto	…
git-remote-testgit.txt	…
git-remote.txt	…
git-repack.txt	…
git-replace.txt	…
git-request-pull.txt	…
git-rerere.txt	treewide: correct several "up-to-date" to "up to date"	8 years ago
git-reset.txt	Spelling fixes	8 years ago
git-rev-list.txt	…
git-rev-parse.txt	Merge branch 'sb/rev-parse-show-superproject-root'	7 years ago
git-revert.txt	…
git-rm.txt	treewide: correct several "up-to-date" to "up to date"	8 years ago
git-send-email.txt	Merge branch 'xz/send-email-batch-size'	8 years ago
git-send-pack.txt	Merge branch 'ma/parse-maybe-bool'	8 years ago
git-sh-i18n--envsubst.txt	…
git-sh-i18n.txt	…
git-sh-setup.txt	…
git-shell.txt	shell: drop git-cvsserver support by default	8 years ago
git-shortlog.txt	…
git-show-branch.txt	…
git-show-index.txt	…
git-show-ref.txt	…
git-show.txt	…
git-stage.txt	…
git-stash.txt	stash: update documentation to use 'stash entry'	8 years ago
git-status.txt	Merge branch 'mr/doc-negative-pathspec' into maint	7 years ago
git-stripspace.txt	…
git-submodule.txt	Merge branch 'sb/submodule-doc'	8 years ago
git-svn.txt	treewide: correct several "up-to-date" to "up to date"	8 years ago
git-symbolic-ref.txt	…
git-tag.txt	Merge branch 'jk/ref-filter-colors-fix' into maint	7 years ago
git-tools.txt	…
git-unpack-file.txt	…
git-unpack-objects.txt	…
git-update-index.txt	Merge branch 'ez/doc-duplicated-words-fix'	8 years ago
git-update-ref.txt	…
git-update-server-info.txt	…
git-upload-archive.txt	…
git-upload-pack.txt	…
git-var.txt	…
git-verify-commit.txt	…
git-verify-pack.txt	…
git-verify-tag.txt	…
git-web--browse.txt	…
git-whatchanged.txt	…
git-worktree.txt	…
git-write-tree.txt	…
git.txt	Merge branch 'ad/doc-markup-fix'	7 years ago
gitattributes.txt	Documentation: mention that `eol` can change the dirty status of paths	8 years ago
gitcli.txt	stash: update documentation to use 'stash entry'	8 years ago
gitcore-tutorial.txt	treewide: correct several "up-to-date" to "up to date"	8 years ago
gitcredentials.txt	…
gitcvs-migration.txt	…
gitdiffcore.txt	…
giteveryday.txt	…
gitglossary.txt	…
githooks.txt	Merge branch 'sb/merge-commit-msg-hook'	8 years ago
gitignore.txt	…
gitk.txt	…
gitmodules.txt	…
gitnamespaces.txt	…
gitremote-helpers.txt	…
gitrepository-layout.txt	treewide: correct several "up-to-date" to "up to date"	8 years ago
gitrevisions.txt	…
gitsubmodules.txt	submodules: overhaul documentation	8 years ago
gittutorial-2.txt	…
gittutorial.txt	treewide: correct several "up-to-date" to "up to date"	8 years ago
gitweb.conf.txt	…
gitweb.txt	…
gitworkflows.txt	…
glossary-content.txt	Merge branch 'mr/doc-negative-pathspec' into maint	7 years ago
howto-index.sh	…
i18n.txt	doc: camelCase the i18n config variables to improve readability	8 years ago
install-doc-quick.sh	…
install-webdoc.sh	…
line-range-format.txt	…
lint-gitlink.perl	…
mailmap.txt	…
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-options.txt	Merge branch 'wk/merge-options-gpg-sign-doc'	7 years ago
merge-strategies.txt	merge-strategies: avoid implying that "-s theirs" exists	8 years ago
pretty-formats.txt	Merge branch 'jk/trailers-parse'	8 years ago
pretty-options.txt	…
pull-fetch-param.txt	fetch doc: src side of refspec could be full SHA-1	7 years ago
rev-list-options.txt	Merge branch 'sg/rev-list-doc-reorder-fix'	7 years ago
revisions.txt	…
sequencer.txt	…
texi.xsl	…
transfer-data-leaks.txt	…
urls-remotes.txt	…
urls.txt	…
user-manual.conf	…
user-manual.txt	treewide: correct several "up-to-date" to "up to date"	8 years ago