diff options
| author | brian m. carlson <sandals@crustytoothpaste.net> | 2025-01-20 01:56:02 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-01-21 12:56:06 -0800 |
| commit | 1f010d6bdf756129db13d1367c888aa4153f6d87 (patch) | |
| tree | 715708841b4980198157a60e72028e25a0059177 /Documentation/git-mergetool--lib.txt | |
| parent | ed4cf6e8e29bebb9324ba1a400a6c07513f2d642 (diff) | |
| download | git-1f010d6bdf756129db13d1367c888aa4153f6d87.tar.xz | |
doc: use .adoc extension for AsciiDoc files
We presently use the ".txt" extension for our AsciiDoc files. While not
wrong, most editors do not associate this extension with AsciiDoc,
meaning that contributors don't get automatic editor functionality that
could be useful, such as syntax highlighting and prose linting.
It is much more common to use the ".adoc" extension for AsciiDoc files,
since this helps editors automatically detect files and also allows
various forges to provide rich (HTML-like) rendering. Let's do that
here, renaming all of the files and updating the includes where
relevant. Adjust the various build scripts and makefiles to use the new
extension as well.
Note that this should not result in any user-visible changes to the
documentation.
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-mergetool--lib.txt')
| -rw-r--r-- | Documentation/git-mergetool--lib.txt | 53 |
1 files changed, 0 insertions, 53 deletions
diff --git a/Documentation/git-mergetool--lib.txt b/Documentation/git-mergetool--lib.txt deleted file mode 100644 index 0726b560d4..0000000000 --- a/Documentation/git-mergetool--lib.txt +++ /dev/null @@ -1,53 +0,0 @@ -git-mergetool{litdd}lib(1) -========================== - -NAME ----- -git-mergetool--lib - Common Git merge tool shell scriptlets - -SYNOPSIS --------- -[verse] -'TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool{litdd}lib"' - -DESCRIPTION ------------ - -This is not a command the end user would want to run. Ever. -This documentation is meant for people who are studying the -Porcelain-ish scripts and/or are writing new ones. - -The 'git-mergetool{litdd}lib' scriptlet is designed to be sourced (using -`.`) by other shell scripts to set up functions for working -with Git merge tools. - -Before sourcing 'git-mergetool{litdd}lib', your script must set `TOOL_MODE` -to define the operation mode for the functions listed below. -'diff' and 'merge' are valid values. - -FUNCTIONS ---------- -get_merge_tool:: - Returns a merge tool. The return code is 1 if we returned a guessed - merge tool, else 0. '$GIT_MERGETOOL_GUI' may be set to 'true' to - search for the appropriate guitool. - -get_merge_tool_cmd:: - Returns the custom command for a merge tool. - -get_merge_tool_path:: - Returns the custom path for a merge tool. - -initialize_merge_tool:: - Brings merge tool specific functions into scope so they can be used or - overridden. - -run_merge_tool:: - Launches a merge tool given the tool name and a true/false - flag to indicate whether a merge base is present. - '$MERGED', '$LOCAL', '$REMOTE', and '$BASE' must be defined - for use by the merge tool. - -GIT ---- -Part of the linkgit:git[1] suite |