git/Documentation at 0cc05b044fd690f37565262a5b09f60c203c5218 - git

History

Ævar Arnfjörð Bjarmason 0cc05b044f usage.c: add a non-fatal bug() function to go with BUG() Add a bug() function to use in cases where we'd like to indicate a runtime BUG(), but would like to defer the BUG() call because we're possibly accumulating more bug() callers to exhaustively indicate what went wrong. We already have this sort of facility in various parts of the codebase, just in the form of ad-hoc re-inventions of the functionality that this new API provides. E.g. this will be used to replace optbug() in parse-options.c, and the 'error("BUG:[...]' we do in a loop in builtin/receive-pack.c. Unlike the code this replaces we'll log to trace2 with this new bug() function (as with other usage.c functions, including BUG()), we'll also be able to avoid calls to xstrfmt() in some cases, as the bug() function itself accepts variadic sprintf()-like arguments. Any caller to bug() can follow up such calls with BUG_if_bug(), which will BUG() out (i.e. abort()) if there were any preceding calls to bug(), callers can also decide not to call BUG_if_bug() and leave the resulting BUG() invocation until exit() time. There are currently no bug() API users that don't call BUG_if_bug() themselves after a for-loop, but allowing for not calling BUG_if_bug() keeps the API flexible. As the tests and documentation here show we'll catch missing BUG_if_bug() invocations in our exit() wrapper. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>		3 years ago
..
RelNotes	Sixth batch	3 years ago
config	Merge branch 'js/use-builtin-add-i'	3 years ago
howto	Document how we do embargoed releases	4 years ago
mergetools	vimdiff: add tool documentation	3 years ago
technical	usage.c: add a non-fatal bug() function to go with BUG()	3 years ago
.gitattributes	…
.gitignore	doc lint: make "lint-docs" non-.PHONY	3 years ago
CodingGuidelines	Documentation/ToolsForGit.txt: Tools for developing Git	3 years ago
Makefile	Merge branch 'cg/tools-for-git-doc'	3 years ago
MyFirstContribution.txt	MyFirstContribution: drop PR description for GGG single-patch contributions	3 years ago
MyFirstObjectWalk.txt	MyFirstObjectWalk: update recommended usage	3 years ago
SubmittingPatches	SubmittingPatches: use more stable git.ozlabs.org URL	3 years ago
ToolsForGit.txt	Documentation/ToolsForGit.txt: Tools for developing Git	3 years ago
asciidoc.conf	…
asciidoctor-extensions.rb	…
blame-options.txt	Merge branch 'bs/doc-blame-color-lines'	3 years ago
build-docdep.perl	…
cat-texi.perl	…
cmd-list.perl	git.txt: add list of guides	5 years ago
config.txt	Git 2.35.2	3 years ago
date-formats.txt	doc: use only hyphens as word separators in placeholders	3 years ago
diff-format.txt	Documentation/diff-format: state in which cases porcelain status is T	3 years ago
diff-generate-patch.txt	doc: point to diff attribute in patch format docs	4 years ago
diff-options.txt	Merge branch 'js/diff-filter-negation-fix'	3 years ago
doc-diff	…
docbook-xsl.css	…
docbook.xsl	…
everyday.txto	…
fetch-options.txt	Merge branch 'rc/fetch-refetch'	3 years ago
fix-texi.perl	…
git-add.txt	add: implement the --sparse option	3 years ago
git-am.txt	am: support --allow-empty to record specific empty patches	3 years ago
git-annotate.txt	…
git-apply.txt	git-apply: add --allow-empty flag	3 years ago
git-archimport.txt	doc: split placeholders as individual tokens	3 years ago
git-archive.txt	archive: describe compression level option	3 years ago
git-bisect-lk2009.txt	git-bisect-lk2009: make continuation of list indented	4 years ago
git-bisect.txt	bisect: swap command-line options in documentation	5 years ago
git-blame.txt	Merge branch 'bs/doc-blame-color-lines'	3 years ago
git-branch.txt	branch: new autosetupmerge option 'simple' for matching branches	3 years ago
git-bugreport.txt	Documentation: fix default directory of git bugreport -o	4 years ago
git-bundle.txt	bundle: move capabilities to end of 'verify'	3 years ago
git-cat-file.txt	Documentation: add --batch-command to cat-file synopsis	3 years ago
git-check-attr.txt	…
git-check-ignore.txt	doc: check-ignore: code-quote an exclamation mark	3 years ago
git-check-mailmap.txt	check-mailmap doc: note config options	4 years ago
git-check-ref-format.txt	…
git-checkout-index.txt	checkout-index: add --ignore-skip-worktree-bits option	3 years ago
git-checkout.txt	Merge branch 'js/branch-track-inherit'	3 years ago
git-cherry-pick.txt	doc: express grammar placeholders between angle brackets	3 years ago
git-cherry.txt	…
git-citool.txt	…
git-clean.txt	…
git-clone.txt	clone, submodule: pass partial clone filters to submodules	3 years ago
git-column.txt	column: fix parsing of the '--nl' option	4 years ago
git-commit-graph.txt	Merge branch 'ds/commit-graph-merging-fix'	4 years ago
git-commit-tree.txt	…
git-commit.txt	Document positive variant of commit and merge option "--no-verify"	3 years ago
git-config.txt	Documentation: add extensions.worktreeConfig details	3 years ago
git-count-objects.txt	…
git-credential-cache--daemon.txt	doc: replace "--" with {litdd} in credential-cache/fsmonitor	3 years ago
git-credential-cache.txt	…
git-credential-store.txt	…
git-credential.txt	doc: fix git credential synopsis	3 years ago
git-cvsexportcommit.txt	doc: express grammar placeholders between angle brackets	3 years ago
git-cvsimport.txt	doc: use only hyphens as word separators in placeholders	3 years ago
git-cvsserver.txt	Documentation: cleanup git-cvsserver	4 years ago
git-daemon.txt	…
git-describe.txt	describe-doc: clarify default length of abbreviation	4 years ago
git-diff-files.txt	doc: use only hyphens as word separators in placeholders	3 years ago
git-diff-index.txt	doc: use only hyphens as word separators in placeholders	3 years ago
git-diff-tree.txt	doc: use only hyphens as word separators in placeholders	3 years ago
git-diff.txt	git-diff: fix missing --merge-base docs	4 years ago
git-difftool.txt	difftool.c: learn a new way start at specified file	4 years ago
git-fast-export.txt	fast-export: allow seeding the anonymized mapping	5 years ago
git-fast-import.txt	fast-import: fix typo in documentation	4 years ago
git-fetch-pack.txt	builtin/fetch-pack: add --refetch option	3 years ago
git-fetch.txt	fetch: fetch unpopulated, changed submodules	3 years ago
git-filter-branch.txt	filter-branch doc: fix filter-repo typo	4 years ago
git-fmt-merge-msg.txt	merge: allow to pretend a merge is made into a different branch	3 years ago
git-for-each-ref.txt	ref-filter: --format=%(raw) support --perl	4 years ago
git-for-each-repo.txt	for-each-repo: run subcommands on configured repos	5 years ago
git-format-patch.txt	doc: git-format-patch: describe the option --always	3 years ago
git-fsck-objects.txt	…
git-fsck.txt	doc: use three dots for indicating repetition instead of star	3 years ago
git-fsmonitor--daemon.txt	doc: replace "--" with {litdd} in credential-cache/fsmonitor	3 years ago
git-gc.txt	docs: clarify that refs/notes/ do not keep the attached objects alive	4 years ago
git-get-tar-commit-id.txt	…
git-grep.txt	docs: fix linting issues due to incorrect relative section order	4 years ago
git-gui.txt	doc: express grammar placeholders between angle brackets	3 years ago
git-hash-object.txt	…
git-help.txt	help: add --no-[external-commands\|aliases] for use with --all	3 years ago
git-hook.txt	git hook run: add an --ignore-missing flag	3 years ago
git-http-backend.txt	docs/http-backend: mention v2 protocol	4 years ago
git-http-fetch.txt	doc: uniformize <URL> placeholders' case	3 years ago
git-http-push.txt	doc: git-http-push: describe the refs as pattern pairs	3 years ago
git-imap-send.txt	git-imap-send.txt: add note about localized Gmail folders	5 years ago
git-index-pack.txt	index-pack: document and test the --promisor option	3 years ago
git-init-db.txt	doc: use only hyphens as word separators in placeholders	3 years ago
git-init.txt	init doc: --shared=0xxx does not give umask but perm bits	3 years ago
git-instaweb.txt	…
git-interpret-trailers.txt	trailer: add new .cmd config option	4 years ago
git-log.txt	doc: use only hyphens as word separators in placeholders	3 years ago
git-ls-files.txt	ls-files: support --recurse-submodules --stage	3 years ago
git-ls-remote.txt	docs: adjust for the recent rename of `pu` to `seen`	5 years ago
git-ls-tree.txt	ls-tree doc: document interaction with submodules	3 years ago
git-mailinfo.txt	mailinfo: allow stripping quoted CR without warning	4 years ago
git-mailsplit.txt	…
git-maintenance.txt	maintenance: fix synopsis in documentation	3 years ago
git-merge-base.txt	…
git-merge-file.txt	update documentation for new zdiff3 conflictStyle	3 years ago
git-merge-index.txt	doc: use three dots for indicating repetition instead of star	3 years ago
git-merge-one-file.txt	…
git-merge-tree.txt	…
git-merge.txt	Merge branch 'jc/merge-detached-head-name'	3 years ago
git-mergetool--lib.txt	mergetool: break setup_tool out into separate initialization function	4 years ago
git-mergetool.txt	vimdiff: add tool documentation	3 years ago
git-mktag.txt	docs: fix linting issues due to incorrect relative section order	4 years ago
git-mktree.txt	fix typo in git-mktree.txt	3 years ago
git-multi-pack-index.txt	git-multi-pack-index.txt: change "folder" to "directory"	3 years ago
git-mv.txt	…
git-name-rev.txt	name-rev: deprecate --stdin in favor of --annotate-stdin	3 years ago
git-notes.txt	docs: improve the example that illustrates git-notes path names	5 years ago
git-p4.txt	git-p4: improve encoding handling to support inconsistent encodings	3 years ago
git-pack-objects.txt	doc: express grammar placeholders between angle brackets	3 years ago
git-pack-redundant.txt	doc: express grammar placeholders between angle brackets	3 years ago
git-pack-refs.txt	…
git-patch-id.txt	…
git-prune-packed.txt	…
git-prune.txt	…
git-pull.txt	Merge branch 'js/retire-preserve-merges'	3 years ago
git-push.txt	Merge branch 'ds/gender-neutral-doc'	4 years ago
git-quiltimport.txt	…
git-range-diff.txt	Merge branch 'js/range-diff-one-side-only'	4 years ago
git-read-tree.txt	Merge branch 'nj/read-tree-doc-reffix'	3 years ago
git-rebase.txt	rebase: use correct base for --keep-base when a branch is given	3 years ago
git-receive-pack.txt	upload-pack: document and rename --advertise-refs	4 years ago
git-reflog.txt	doc: express grammar placeholders between angle brackets	3 years ago
git-remote-ext.txt	…
git-remote-fd.txt	…
git-remote-helpers.txto	…
git-remote.txt	builtin/remote.c: teach `-v` to list filters for promisor remotes	3 years ago
git-repack.txt	repack: make '--quiet' disable progress	3 years ago
git-replace.txt	…
git-request-pull.txt	doc: uniformize <URL> placeholders' case	3 years ago
git-rerere.txt	…
git-reset.txt	reset: remove 'reset.refresh' config option	3 years ago
git-restore.txt	update documentation for new zdiff3 conflictStyle	3 years ago
git-rev-list.txt	docs/rev-list: add some examples of --disk-usage	4 years ago
git-rev-parse.txt	rev-parse: add option for absolute or relative path formatting	4 years ago
git-revert.txt	Documentation: stylistically normalize references to Signed-off-by:	4 years ago
git-rm.txt	rm: add --sparse option	3 years ago
git-send-email.txt	send-email docs: add format-patch options	3 years ago
git-send-pack.txt	send-pack: properly use parse_options() API for usage string	4 years ago
git-sh-i18n--envsubst.txt	…
git-sh-i18n.txt	…
git-sh-setup.txt	…
git-shell.txt	…
git-shortlog.txt	doc: use only hyphens as word separators in placeholders	3 years ago
git-show-branch.txt	…
git-show-index.txt	Documentation: mark `--object-format=sha256` as experimental	5 years ago
git-show-ref.txt	…
git-show.txt	doc/git-show: include --diff-merges description	4 years ago
git-sparse-checkout.txt	Merge branch 'en/present-despite-skipped'	3 years ago
git-stage.txt	doc: express grammar placeholders between angle brackets	3 years ago
git-stash.txt	stash: implement '--staged' option for 'push' and 'save'	3 years ago
git-status.txt	status: print stash info with --porcelain=v2 --show-stash	3 years ago
git-stripspace.txt	…
git-submodule.txt	clone, submodule: pass partial clone filters to submodules	3 years ago
git-svn.txt	Merge branch 'ja/doc-cleanup'	3 years ago
git-switch.txt	Merge branch 'js/branch-track-inherit'	3 years ago
git-symbolic-ref.txt	…
git-tag.txt	Documentation: typofix --column description	4 years ago
git-tools.txt	…
git-unpack-file.txt	…
git-unpack-objects.txt	…
git-update-index.txt	doc: replace "--" with {litdd} in credential-cache/fsmonitor	3 years ago
git-update-ref.txt	update-ref: allow creation of multiple transactions	4 years ago
git-update-server-info.txt	…
git-upload-archive.txt	…
git-upload-pack.txt	Merge branch 'jk/http-server-protocol-versions'	4 years ago
git-var.txt	var: add GIT_DEFAULT_BRANCH variable	3 years ago
git-verify-commit.txt	…
git-verify-pack.txt	…
git-verify-tag.txt	…
git-version.txt	documentation: add documentation for 'git version'	4 years ago
git-web--browse.txt	doc: split placeholders as individual tokens	3 years ago
git-whatchanged.txt	…
git-worktree.txt	Merge branch 'pw/worktree-list-with-z'	3 years ago
git-write-tree.txt	…
git.txt	cli: add -v and -h shorthands	3 years ago
gitattributes.txt	userdiff: add builtin diff driver for kotlin language.	3 years ago
gitcli.txt	git-cli.txt: clarify "options first and then args"	3 years ago
gitcore-tutorial.txt	…
gitcredentials.txt	doc: uniformize <URL> placeholders' case	3 years ago
gitcvs-migration.txt	…
gitdiffcore.txt	Merge branch 'en/ort-perf-batch-8'	4 years ago
giteveryday.txt	docs: adjust for the recent rename of `pu` to `seen`	5 years ago
gitfaq.txt	Update docs for change of default merge backend	4 years ago
gitglossary.txt	…
githooks.txt	hook: add 'run' subcommand	3 years ago
gitignore.txt	gitignore.txt: change "folder" to "directory"	3 years ago
gitk.txt	doc: log, gitk: move '-L' description to 'line-range-options.txt'	4 years ago
gitmailmap.txt	docs: document symlink restrictions for dot-files	4 years ago
gitmodules.txt	docs: document symlink restrictions for dot-files	4 years ago
gitnamespaces.txt	doc lint: lint and fix missing "GIT" end sections	4 years ago
gitremote-helpers.txt	Merge branch 'bc/sha-256-part-2'	5 years ago
gitrepository-layout.txt	…
gitrevisions.txt	…
gitsubmodules.txt	doc: uniformize <URL> placeholders' case	3 years ago
gittutorial-2.txt	…
gittutorial.txt	Documentation: render special characters correctly	4 years ago
gitweb.conf.txt	gitweb: add "e-mail privacy" feature to redact e-mail addresses	4 years ago
gitweb.txt	gitweb.txt: change "folder" to "directory"	3 years ago
gitworkflows.txt	doc: uniformize <URL> placeholders' case	3 years ago
glossary-content.txt	glossary: describe "worktree"	3 years ago
howto-index.sh	…
i18n.txt	i18n.txt: camel case and monospace "i18n.commitEncoding"	4 years ago
install-doc-quick.sh	…
install-webdoc.sh	…
line-range-format.txt	doc: add more pointers to gitattributes(5) for userdiff	4 years ago
line-range-options.txt	blame-options.txt: also mention 'funcname' in '-L' description	4 years ago
lint-gitlink.perl	doc lint: make "lint-docs" non-.PHONY	3 years ago
lint-man-end-blurb.perl	doc lint: emit errors on STDERR	3 years ago
lint-man-section-order.perl	doc lint: emit errors on STDERR	3 years ago
manpage-base-url.xsl.in	…
manpage-bold-literal.xsl	…
manpage-normal.xsl	…
manpage-quote-apos.xsl	…
manpage.xsl	…
merge-options.txt	Document positive variant of commit and merge option "--no-verify"	3 years ago
merge-strategies.txt	Update docs for change of default merge backend	4 years ago
object-format-disclaimer.txt	Documentation: mark `--object-format=sha256` as experimental	5 years ago
pretty-formats.txt	Merge branch 'es/pretty-describe-more'	3 years ago
pretty-options.txt	log: document --encoding behavior on iconv() failure	3 years ago
pull-fetch-param.txt	refspec: add support for negative refspecs	5 years ago
ref-reachability-filters.txt	Doc: prefer more specific file name	5 years ago
rev-list-description.txt	git-log.txt: include rev-list-description.txt	5 years ago
rev-list-options.txt	log: "--since-as-filter" option is a non-terminating "--since" variant	3 years ago
revisions.txt	revisions(7): clarify that most commands take a single revision range	4 years ago
sequencer.txt	…
signoff-option.txt	Documentation: stylistically normalize references to Signed-off-by:	4 years ago
texi.xsl	…
trace2-target-values.txt	…
transfer-data-leaks.txt	…
urls-remotes.txt	doc: uniformize <URL> placeholders' case	3 years ago
urls.txt	…
user-manual.conf	…
user-manual.txt	Update docs for change of default merge backend	4 years ago