From patchwork Sat Nov 16 19:36:04 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila?= X-Patchwork-Id: 13877715 Received: from mail-wm1-f46.google.com (mail-wm1-f46.google.com [209.85.128.46]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id C4ABA194A52 for ; Sat, 16 Nov 2024 19:36:13 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.46 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731785775; cv=none; b=uMeE9/hw0sYTyLdSOhQ9BvLOimr9Bm7iQMPPmcmTVxYuVBcdAUfeeyb+FQetHd6lFpImL0lqpu4liIyhjwjakG8nmSXn60nduzb2eekTkH+z74D8WKret6RvBJTb/Fn+9dNXpfC8O5XIgLArscLSKqxtvHVFg3vilPJzU7RAhcA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731785775; c=relaxed/simple; bh=ZgYJS9FJ+kYWce1LJnJV279bbYBPaLhtmpq/JA15WUY=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=OA9oK72sPszCMm7QgFf3YF5SmI5hipROm1dEXBRdygtNPqRkVXoJ/aNJJQuzbc8TE9mjIXcd2KtNGt2mg8jXX17ivrV0VWKHWFEi3r50FslRWFG01sTv2j2wG9+3595B6ds2pjnS0yYooq/zJUzCsDmIeKVR/GvSG17jj9zrKlM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=b7UEnAB3; arc=none smtp.client-ip=209.85.128.46 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="b7UEnAB3" Received: by mail-wm1-f46.google.com with SMTP id 5b1f17b1804b1-4316a44d1bbso14900315e9.3 for ; Sat, 16 Nov 2024 11:36:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731785771; x=1732390571; darn=vger.kernel.org; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=MX8qAB/CYlQSsBQAIX2SXb4bfy3bhNcI8ah7NaOigxs=; b=b7UEnAB3vjT0whFq9ZQc4ARF0CqSP5SKEsrnmWsrmPrnhl/HluKb49eTfqQN5ZV5hD AejCgMRaRPWSx0Oe08BQ1Bul/5umRJ63kIDpE5y/b1NbLK+HKgzT9/BQcwoJYK0atS2F JDWO3R3I11/pVOcqJOER1u8QwB9n8CYgU+gja8M0EyftTLeQ50+2V2SfUFtNiB5hnhvv mRyTjvfFihDXtBeyMX+HazAHd22UL41fjpy1mN8bvmx2RjAhdIGoXLkcCCbK6vcTcMGR 6LJ0ZiWgE9gqfLkGM+jrJODgsRtA2RurRdW9AhYTVBeJgt+aZZdS3NLeuxh1ZXQYinCx +bdQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731785771; x=1732390571; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=MX8qAB/CYlQSsBQAIX2SXb4bfy3bhNcI8ah7NaOigxs=; b=Rs0fxmt7HOLOtNacngwnKaq9+qnatq52sjPQ0ZAgt4KyRyqCb6krHkWBAfx+FJLSZr 50Tj21/GcThluP2RaqXFH+HLvNRN3onSrrKIVj8JhPhnEC8r078J+pCcADAppldve3me gb0jMlWe6BYSDX2xVVmtQqA+soK/V6GpNLpyDchj8oO1ZaYMjsyUG+Tmr3q7HJIh1HRA JiZcynLJNpHxHrn36OxmjylsSD/rnuN7sA9WWxZvimIke8Gik0jlPcQU8WPMoD2kXjNu Qp1Ypnb8foijm1pEqXvozDwSzPQwWbcgFtvn1jCj20tSz1i1rnrEcmaq6KlWOyatPFj8 w9Qg== X-Gm-Message-State: AOJu0Yz+NrAyDL/Fz8B/GIhhu4DeE1iXq3EEd2Zv8i6W2V2YGBVmVKV9 fJKhMPjOlk6MrCkKsDEX9roh90dsWzctknr5ZfdF7xJpFVoT9JcGquY1Hw== X-Google-Smtp-Source: AGHT+IFwemcCG4Dsli9YCh8YKMgVxx/7J8rMz7jw1PPoKVVI5gBpTBQnt4AA0t6irW8FXB6dFRDT5w== X-Received: by 2002:a05:600c:3584:b0:431:5c17:d575 with SMTP id 5b1f17b1804b1-432df72c841mr60005975e9.11.1731785771280; Sat, 16 Nov 2024 11:36:11 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3821ae15d89sm8170345f8f.77.2024.11.16.11.36.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 Nov 2024 11:36:10 -0800 (PST) Message-Id: <6841bd5825be8e7b17c2f9c3a997de29ffa3a540.1731785769.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Sat, 16 Nov 2024 19:36:04 +0000 Subject: [PATCH v3 1/5] doc: git-diff: apply new documentation guidelines Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Johannes Sixt , Patrick Steinhardt , =?utf-8?q?Jean-No=C3=ABl?= Avila , =?utf-8?q?Jean-No?= =?utf-8?q?=C3=ABl_Avila?= From: =?utf-8?q?Jean-No=C3=ABl_Avila?= From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= The documentation for git-diff has been updated to follow the new documentation guidelines. The following changes have been applied to the series of patches: - switching the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace - use __ instead of in the description - use `backticks for keywords and more complex option descriptions`. The new rendering engine will apply synopsis rules to these spans. - prevent git-diff from self-referencing itself via gitlink macro when the generated link would point to the same page. Signed-off-by: Jean-Noël Avila --- Documentation/git-diff.txt | 108 +++++++++++++++++++------------------ 1 file changed, 57 insertions(+), 51 deletions(-) diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index c065f023eca..dfa031d7386 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -8,13 +8,13 @@ git-diff - Show changes between commits, commit and working tree, etc SYNOPSIS -------- -[verse] -'git diff' [] [] [--] [...] -'git diff' [] --cached [--merge-base] [] [--] [...] -'git diff' [] [--merge-base] [...] [--] [...] -'git diff' [] ... [--] [...] -'git diff' [] -'git diff' [] --no-index [--] +[synopsis] +git diff [] [] [--] [...] +git diff [] --cached [--merge-base] [] [--] [...] +git diff [] [--merge-base] [...] [--] [...] +git diff [] ... [--] [...] +git diff [] +git diff [] --no-index [--] DESCRIPTION ----------- @@ -23,7 +23,7 @@ between the index and a tree, changes between two trees, changes resulting from a merge, changes between two blob objects, or changes between two files on disk. -'git diff' [] [--] [...]:: +`git diff [] [--] [...]`:: This form is to view the changes you made relative to the index (staging area for the next commit). In other @@ -31,7 +31,7 @@ files on disk. further add to the index but you still haven't. You can stage these changes by using linkgit:git-add[1]. -'git diff' [] --no-index [--] :: +`git diff [] --no-index [--] `:: This form is to compare the given two paths on the filesystem. You can omit the `--no-index` option when @@ -40,82 +40,82 @@ files on disk. or when running the command outside a working tree controlled by Git. This form implies `--exit-code`. -'git diff' [] --cached [--merge-base] [] [--] [...]:: +`git diff [] --cached [--merge-base] [] [--] [...]`:: This form is to view the changes you staged for the next - commit relative to the named . Typically you + commit relative to the named __. Typically you would want comparison with the latest commit, so if you - do not give , it defaults to HEAD. - If HEAD does not exist (e.g. unborn branches) and - is not given, it shows all staged changes. - --staged is a synonym of --cached. + do not give __, it defaults to `HEAD`. + If `HEAD` does not exist (e.g. unborn branches) and + __ is not given, it shows all staged changes. + `--staged` is a synonym of `--cached`. + -If --merge-base is given, instead of using , use the merge base -of and HEAD. `git diff --cached --merge-base A` is equivalent to +If `--merge-base` is given, instead of using __, use the merge base +of __ and `HEAD`. `git diff --cached --merge-base A` is equivalent to `git diff --cached $(git merge-base A HEAD)`. -'git diff' [] [--merge-base] [--] [...]:: +`git diff [] [--merge-base] [--] [...]`:: This form is to view the changes you have in your - working tree relative to the named . You can - use HEAD to compare it with the latest commit, or a + working tree relative to the named __. You can + use `HEAD` to compare it with the latest commit, or a branch name to compare with the tip of a different branch. + -If --merge-base is given, instead of using , use the merge base -of and HEAD. `git diff --merge-base A` is equivalent to +If `--merge-base` is given, instead of using __, use the merge base +of __ and `HEAD`. `git diff --merge-base A` is equivalent to `git diff $(git merge-base A HEAD)`. -'git diff' [] [--merge-base] [--] [...]:: +`git diff [] [--merge-base] [--] [...]`:: This is to view the changes between two arbitrary - . + __. + -If --merge-base is given, use the merge base of the two commits for the +If `--merge-base` is given, use the merge base of the two commits for the "before" side. `git diff --merge-base A B` is equivalent to `git diff $(git merge-base A B) B`. -'git diff' [] ... [--] [...]:: +`git diff [] ... [--] [...]`:: This form is to view the results of a merge commit. The first - listed must be the merge itself; the remaining two or + listed __ must be the merge itself; the remaining two or more commits should be its parents. Convenient ways to produce - the desired set of revisions are to use the suffixes `^@` and - `^!`. If A is a merge commit, then `git diff A A^@`, + the desired set of revisions are to use the suffixes `@` and + `^!`. If `A` is a merge commit, then `git diff A A^@`, `git diff A^!` and `git show A` all give the same combined diff. -'git diff' [] .. [--] [...]:: +`git diff [] .. [--] [...]`:: This is synonymous to the earlier form (without the `..`) for - viewing the changes between two arbitrary . If on + viewing the changes between two arbitrary __. If __ on one side is omitted, it will have the same effect as - using HEAD instead. + using `HEAD` instead. -'git diff' [] \... [--] [...]:: +`git diff [] ... [--] [...]`:: This form is to view the changes on the branch containing - and up to the second , starting at a common ancestor - of both . `git diff A...B` is equivalent to + and up to the second __, starting at a common ancestor + of both __. `git diff A...B` is equivalent to `git diff $(git merge-base A B) B`. You can omit any one - of , which has the same effect as using HEAD instead. + of __, which has the same effect as using `HEAD` instead. Just in case you are doing something exotic, it should be -noted that all of the in the above description, except +noted that all of the __ in the above description, except in the `--merge-base` case and in the last two forms that use `..` -notations, can be any . A tree of interest is the one pointed to -by the ref named `AUTO_MERGE`, which is written by the 'ort' merge +notations, can be any __. A tree of interest is the one pointed to +by the ref named `AUTO_MERGE`, which is written by the `ort` merge strategy upon hitting merge conflicts (see linkgit:git-merge[1]). Comparing the working tree with `AUTO_MERGE` shows changes you've made so far to resolve textual conflicts (see the examples below). -For a more complete list of ways to spell , see +For a more complete list of ways to spell __, see "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7]. -However, "diff" is about comparing two _endpoints_, not ranges, -and the range notations (`..` and -`...`) do not mean a range as defined in the +However, `diff` is about comparing two _endpoints_, not ranges, +and the range notations (`..` and `...`) +do not mean a range as defined in the "SPECIFYING RANGES" section in linkgit:gitrevisions[7]. -'git diff' [] :: +`git diff [] `:: This form is to view the differences between the raw contents of two blob objects. @@ -125,22 +125,27 @@ OPTIONS :git-diff: 1 include::diff-options.txt[] --1 --base:: --2 --ours:: --3 --theirs:: +`-1`:: +`--base`:: + +or `-2`:: +`--ours`:: + +or `-3`:: +`--theirs`:: Compare the working tree with the "base" version (stage #1), "our branch" (stage #2) or "their branch" (stage #3). The index contains these stages only for unmerged entries i.e. while resolving conflicts. See linkgit:git-read-tree[1] section "3-Way Merge" for detailed information. --0:: +`-0`:: Omit diff output for unmerged entries and just show "Unmerged". Can be used only when comparing the working tree with the index. -...:: - The parameters, when given, are used to limit +`...`:: + The __ parameters, when given, are used to limit the diff to the named paths (you can give directory names and get diff for all files under them). @@ -225,11 +230,12 @@ CONFIGURATION include::includes/cmd-config-section-all.txt[] +:git-diff: 1 include::config/diff.txt[] SEE ALSO -------- -diff(1), +`diff`(1), linkgit:git-difftool[1], linkgit:git-log[1], linkgit:gitdiffcore[7], From patchwork Sat Nov 16 19:36:05 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila?= X-Patchwork-Id: 13877717 Received: from mail-wr1-f42.google.com (mail-wr1-f42.google.com [209.85.221.42]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id EC9E619ADA2 for ; Sat, 16 Nov 2024 19:36:16 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.42 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731785780; cv=none; b=Ql3uIVQAd5Oc7/ziOBROEomfC/Yuc+6MRaZq2eRfvFOnHMkC6eEOpkigBsnGtce18VS15l2u+DxruV9VpeliR3El+gd7hwhIoRwxCmkS00fekDR7mZMQw7uLLaZqb1wuR5MpP0v+bFOjtX588zqqHfdG+RzkTMlfJCtr09ORM9Y= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731785780; c=relaxed/simple; bh=qGABfrpY4x02r0t2K8tF5fKemhjCA6N0D4awE+SiuqI=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=iDTQGvfDP1c0S6WgjMBWrRsNlaqr82PGLJ0N4wj7VlyFNf8hOabsnbr3XBqPclkkeACPpJ7xSNdYrMbb/BXBF3I88N/NZhVXFq0X+iRnJ0QkLnqm0mYkFz8DVwGkQwojKdHBEMmsPA+6cfS5n6ldUcQXg1XkYf9XTusomwZV2PM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=Bib9D0uM; arc=none smtp.client-ip=209.85.221.42 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="Bib9D0uM" Received: by mail-wr1-f42.google.com with SMTP id ffacd0b85a97d-3822429c615so866389f8f.1 for ; Sat, 16 Nov 2024 11:36:16 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731785773; x=1732390573; darn=vger.kernel.org; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=wikHvCxFh/2p+QPUb7E3saY8JSa8IrlEfCddY97Xhs0=; b=Bib9D0uMiwWNYZ8qIrZMZiR2qKeo3fWTZfHB0uFIP477SWIhoUOFJk8hjG9/p10BdE y2DkeRQANhKfy+YCpHURvIyE9nmFsr+E2yB8XV+GLAtQgFbV/z+fZ7DdJHSk8DU1xsWq aNbgJitGu4ovwoxzMAjjxzOZ3h/Lr3D+HM91JZOlYlS4NcyLBbZ9zRs8qhqApnMKx2Nd QgVDnq7lHc96f0lwngGbrto8hu+KcqX8y7QuBw6qvxYYnZby2soJyXfKnZjVx+pEwDs2 rGrO4ZbJ+Zv4HPScejklr8iFv/VQbNfzl3BwZhWqz1bmeuJS1QpG5m0+bkIHje6OgBvE mnkw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731785773; x=1732390573; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=wikHvCxFh/2p+QPUb7E3saY8JSa8IrlEfCddY97Xhs0=; b=UIxbbxEEcZwOkZ4kLYnbELXKZE8Ewmz/LeK0ckzi8/krXu41A7xIKtGaDvtaPoKF2v BSN7Rf1TjI/tzT6uImKqcpUsS0DZfkWxUz7ShyVHk4SUiSX7LL2lRICHxEephAMJO1VX vEuAroHbZX+Ldwr60fYZmIaBW5tintYy/Wlev+vqa+P6/kxG4JwmXyVXt/iQJnR/iZkx hqIExVZdFFGBkM+NEgRjBFBqU9hdRWKcBNfX4C46oCjM8696kOnD2PFzumld8Q2dO2EZ WSg3W0RLngfR29JppNmA8l540YlJxc7eb68S/SvNPjoUmlocStXNA0VYZU4Syz67GTLE Q2Xg== X-Gm-Message-State: AOJu0YxJXMDq9nbMM4U+M1+VIFUAKlOn4k0RduoHq5YHcoiuKMSLKUyC AQzz936hoBU9PJxX4eTqb/4IYrSA3xQb0+rBLSGbWo8RdY4esUVekfUMVA== X-Google-Smtp-Source: AGHT+IGEyOvROJN/iPlY2NAzpeUYVN3a341bLEoP+7GGpkNEjcSU1LrA//jipogGbyLXU2eTw/LHxQ== X-Received: by 2002:a05:6000:1569:b0:382:376f:e4cf with SMTP id ffacd0b85a97d-382376feb55mr2524029f8f.15.1731785772763; Sat, 16 Nov 2024 11:36:12 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3823e5f7429sm915563f8f.93.2024.11.16.11.36.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 Nov 2024 11:36:11 -0800 (PST) Message-Id: <07df397741be815b64383fdd6755f57ece6af5fa.1731785769.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Sat, 16 Nov 2024 19:36:05 +0000 Subject: [PATCH v3 2/5] doc: git-diff: apply format changes to diff-options Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Johannes Sixt , Patrick Steinhardt , =?utf-8?q?Jean-No=C3=ABl?= Avila , =?utf-8?q?Jean-No?= =?utf-8?q?=C3=ABl_Avila?= From: =?utf-8?q?Jean-No=C3=ABl_Avila?= From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= The format change is only applied to the sections of the file that are filtered in git-diff. Signed-off-by: Jean-Noël Avila --- Documentation/diff-options.txt | 423 +++++++++++++++++---------------- 1 file changed, 212 insertions(+), 211 deletions(-) diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt index cd0b81adbb6..640eb6e7db5 100644 --- a/Documentation/diff-options.txt +++ b/Documentation/diff-options.txt @@ -19,16 +19,16 @@ ifdef::git-format-patch[] endif::git-format-patch[] ifndef::git-format-patch[] --p:: --u:: ---patch:: +`-p`:: +`-u`:: +`--patch`:: Generate patch (see <>). ifdef::git-diff[] This is the default. endif::git-diff[] --s:: ---no-patch:: +`-s`:: +`--no-patch`:: Suppress all output from the diff machinery. Useful for commands like `git show` that show the patch by default to squelch their output, or to cancel the effect of options like @@ -39,28 +39,28 @@ endif::git-format-patch[] ifdef::git-log[] -m:: Show diffs for merge commits in the default format. This is - similar to '--diff-merges=on', except `-m` will + similar to `--diff-merges=on`, except `-m` will produce no output unless `-p` is given as well. -c:: Produce combined diff output for merge commits. - Shortcut for '--diff-merges=combined -p'. + Shortcut for `--diff-merges=combined -p`. --cc:: Produce dense combined diff output for merge commits. - Shortcut for '--diff-merges=dense-combined -p'. + Shortcut for `--diff-merges=dense-combined -p`. --dd:: Produce diff with respect to first parent for both merge and regular commits. - Shortcut for '--diff-merges=first-parent -p'. + Shortcut for `--diff-merges=first-parent -p`. --remerge-diff:: Produce remerge-diff output for merge commits. - Shortcut for '--diff-merges=remerge -p'. + Shortcut for `--diff-merges=remerge -p`. --no-diff-merges:: - Synonym for '--diff-merges=off'. + Synonym for `--diff-merges=off`. --diff-merges=:: Specify diff format to be used for merge commits. Default is @@ -73,33 +73,33 @@ The following formats are supported: off, none:: Disable output of diffs for merge commits. Useful to override implied value. -+ + on, m:: Make diff output for merge commits to be shown in the default format. The default format can be changed using `log.diffMerges` configuration variable, whose default value is `separate`. -+ + first-parent, 1:: Show full diff with respect to first parent. This is the same format as `--patch` produces for non-merge commits. -+ + separate:: Show full diff with respect to each of parents. Separate log entry and diff is generated for each parent. -+ + combined, c:: Show differences from each of the parents to the merge result simultaneously instead of showing pairwise diff between a parent and the result one at a time. Furthermore, it lists only files which were modified from all parents. -+ + dense-combined, cc:: Further compress output produced by `--diff-merges=combined` by omitting uninteresting hunks whose contents in the parents have only two variants and the merge result picks one of them without modification. -+ + remerge, r:: Remerge two-parent merge commits to create a temporary tree object--potentially containing files with conflict markers @@ -112,33 +112,33 @@ documented). -- --combined-all-paths:: - This flag causes combined diffs (used for merge commits) to + Cause combined diffs (used for merge commits) to list the name of the file from all parents. It thus only has effect when `--diff-merges=[dense-]combined` is in use, and is likely only useful if filename changes are detected (i.e. when either rename or copy detection have been requested). endif::git-log[] --U:: ---unified=:: - Generate diffs with lines of context instead of +`-U`:: +`--unified=`:: + Generate diffs with __ lines of context instead of the usual three. ifndef::git-format-patch[] Implies `--patch`. endif::git-format-patch[] ---output=:: +`--output=`:: Output to a specific file instead of stdout. ---output-indicator-new=:: ---output-indicator-old=:: ---output-indicator-context=:: +`--output-indicator-new=`:: +`--output-indicator-old=`:: +`--output-indicator-context=`:: Specify the character used to indicate new, old or context - lines in the generated patch. Normally they are '+', '-' and + lines in the generated patch. Normally they are `+`, `-` and ' ' respectively. ifndef::git-format-patch[] ---raw:: +`--raw`:: ifndef::git-log[] Generate the diff in raw format. ifdef::git-diff-core[] @@ -155,54 +155,55 @@ endif::git-log[] endif::git-format-patch[] ifndef::git-format-patch[] ---patch-with-raw:: +`--patch-with-raw`:: Synonym for `-p --raw`. endif::git-format-patch[] ifdef::git-log[] --t:: +`-t`:: Show the tree objects in the diff output. endif::git-log[] ---indent-heuristic:: +`--indent-heuristic`:: Enable the heuristic that shifts diff hunk boundaries to make patches easier to read. This is the default. ---no-indent-heuristic:: +`--no-indent-heuristic`:: Disable the indent heuristic. ---minimal:: +`--minimal`:: Spend extra time to make sure the smallest possible diff is produced. ---patience:: +`--patience`:: Generate a diff using the "patience diff" algorithm. ---histogram:: +`--histogram`:: Generate a diff using the "histogram diff" algorithm. ---anchored=:: +`--anchored=`:: Generate a diff using the "anchored diff" algorithm. + This option may be specified more than once. + If a line exists in both the source and destination, exists only once, -and starts with this text, this algorithm attempts to prevent it from +and starts with __, this algorithm attempts to prevent it from appearing as a deletion or addition in the output. It uses the "patience diff" algorithm internally. ---diff-algorithm={patience|minimal|histogram|myers}:: +`--diff-algorithm=(patience|minimal|histogram|myers)`:: Choose a diff algorithm. The variants are as follows: + -- -`default`, `myers`;; + `default`;; + `myers`;; The basic greedy diff algorithm. Currently, this is the default. -`minimal`;; + `minimal`;; Spend extra time to make sure the smallest possible diff is produced. -`patience`;; + `patience`;; Use "patience diff" algorithm when generating patches. -`histogram`;; + `histogram`;; This algorithm extends the patience algorithm to "support low-occurrence common elements". -- @@ -211,47 +212,47 @@ For instance, if you configured the `diff.algorithm` variable to a non-default value and want to use the default one, then you have to use `--diff-algorithm=default` option. ---stat[=[,[,]]]:: +`--stat[=[,[,]]]`:: Generate a diffstat. By default, as much space as necessary will be used for the filename part, and the rest for the graph part. Maximum width defaults to terminal width, or 80 columns if not connected to a terminal, and can be overridden by - ``. The width of the filename part can be limited by - giving another width `` after a comma or by setting - `diff.statNameWidth=`. The width of the graph part can be - limited by using `--stat-graph-width=` or by setting - `diff.statGraphWidth=`. Using `--stat` or + __. The width of the filename part can be limited by + giving another width __ after a comma or by setting + `diff.statNameWidth=`. The width of the graph part can be + limited by using `--stat-graph-width=` or by setting + `diff.statGraphWidth=`. Using `--stat` or `--stat-graph-width` affects all commands generating a stat graph, while setting `diff.statNameWidth` or `diff.statGraphWidth` does not affect `git format-patch`. - By giving a third parameter ``, you can limit the output to - the first `` lines, followed by `...` if there are more. + By giving a third parameter __, you can limit the output to + the first __ lines, followed by `...` if there are more. + These parameters can also be set individually with `--stat-width=`, `--stat-name-width=` and `--stat-count=`. ---compact-summary:: +`--compact-summary`:: Output a condensed summary of extended header information such - as file creations or deletions ("new" or "gone", optionally "+l" - if it's a symlink) and mode changes ("+x" or "-x" for adding + as file creations or deletions ("new" or "gone", optionally `+l` + if it's a symlink) and mode changes (`+x` or `-x` for adding or removing executable bit respectively) in diffstat. The information is put between the filename part and the graph part. Implies `--stat`. ---numstat:: +`--numstat`:: Similar to `--stat`, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly. For binary files, outputs two `-` instead of saying `0 0`. ---shortstat:: +`--shortstat`:: Output only the last line of the `--stat` format containing total number of modified files, as well as number of added and deleted lines. --X[]:: ---dirstat[=]:: +`-X [,...]`:: +`--dirstat[=,...]`:: Output the distribution of relative amount of changes for each sub-directory. The behavior of `--dirstat` can be customized by passing it a comma separated list of parameters. @@ -284,7 +285,7 @@ These parameters can also be set individually with `--stat-width=`, Note that when using `cumulative`, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can be specified with the `noncumulative` parameter. -;; +__;; An integer parameter specifies a cut-off percent (3% by default). Directories contributing less than this percentage of the changes are not shown in the output. @@ -295,29 +296,29 @@ directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: `--dirstat=files,10,cumulative`. ---cumulative:: - Synonym for --dirstat=cumulative +`--cumulative`:: + Synonym for `--dirstat=cumulative`. ---dirstat-by-file[=...]:: - Synonym for --dirstat=files,,... +`--dirstat-by-file[=,...]`:: + Synonym for `--dirstat=files,,...`. ---summary:: +`--summary`:: Output a condensed summary of extended header information such as creations, renames and mode changes. ifndef::git-format-patch[] ---patch-with-stat:: +`--patch-with-stat`:: Synonym for `-p --stat`. endif::git-format-patch[] ifndef::git-format-patch[] --z:: +`-z`:: ifdef::git-log[] - Separate the commits with NULs instead of newlines. + Separate the commits with __NUL__s instead of newlines. + Also, when `--raw` or `--numstat` has been given, do not munge -pathnames and use NULs as output field terminators. +pathnames and use __NUL__s as output field terminators. endif::git-log[] ifndef::git-log[] When `--raw`, `--numstat`, `--name-only` or `--name-status` has been @@ -328,89 +329,89 @@ Without this option, pathnames with "unusual" characters are quoted as explained for the configuration variable `core.quotePath` (see linkgit:git-config[1]). ---name-only:: +`--name-only`:: Show only the name of each changed file in the post-image tree. The file names are often encoded in UTF-8. For more information see the discussion about encoding in the linkgit:git-log[1] manual page. ---name-status:: +`--name-status`:: Show only the name(s) and status of each changed file. See the description of the `--diff-filter` option on what the status letters mean. Just like `--name-only` the file names are often encoded in UTF-8. ---submodule[=]:: +`--submodule[=]`:: Specify how differences in submodules are shown. When specifying - `--submodule=short` the 'short' format is used. This format just + `--submodule=short` the `short` format is used. This format just shows the names of the commits at the beginning and end of the range. - When `--submodule` or `--submodule=log` is specified, the 'log' + When `--submodule` or `--submodule=log` is specified, the `log` format is used. This format lists the commits in the range like linkgit:git-submodule[1] `summary` does. When `--submodule=diff` - is specified, the 'diff' format is used. This format shows an + is specified, the `diff` format is used. This format shows an inline diff of the changes in the submodule contents between the - commit range. Defaults to `diff.submodule` or the 'short' format + commit range. Defaults to `diff.submodule` or the `short` format if the config option is unset. ---color[=]:: +`--color[=]`:: Show colored diff. - `--color` (i.e. without '=') is the same as `--color=always`. - '' can be one of `always`, `never`, or `auto`. + `--color` (i.e. without `=`) is the same as `--color=always`. + __ can be one of `always`, `never`, or `auto`. ifdef::git-diff[] It can be changed by the `color.ui` and `color.diff` configuration settings. endif::git-diff[] ---no-color:: +`--no-color`:: Turn off colored diff. ifdef::git-diff[] This can be used to override configuration settings. endif::git-diff[] It is the same as `--color=never`. ---color-moved[=]:: +`--color-moved[=]`:: Moved lines of code are colored differently. ifdef::git-diff[] It can be changed by the `diff.colorMoved` configuration setting. endif::git-diff[] - The defaults to 'no' if the option is not given - and to 'zebra' if the option with no mode is given. + The __ defaults to `no` if the option is not given + and to `zebra` if the option with no mode is given. The mode must be one of: + -- -no:: +`no`:: Moved lines are not highlighted. -default:: +`default`:: Is a synonym for `zebra`. This may change to a more sensible mode in the future. -plain:: +`plain`:: Any line that is added in one location and was removed - in another location will be colored with 'color.diff.newMoved'. - Similarly 'color.diff.oldMoved' will be used for removed lines + in another location will be colored with `color.diff.newMoved`. + Similarly `color.diff.oldMoved` will be used for removed lines that are added somewhere else in the diff. This mode picks up any moved line, but it is not very useful in a review to determine if a block of code was moved without permutation. -blocks:: +`blocks`:: Blocks of moved text of at least 20 alphanumeric characters are detected greedily. The detected blocks are - painted using either the 'color.diff.{old,new}Moved' color. + painted using either the `color.diff.(old|new)Moved` color. Adjacent blocks cannot be told apart. -zebra:: - Blocks of moved text are detected as in 'blocks' mode. The blocks - are painted using either the 'color.diff.{old,new}Moved' color or - 'color.diff.{old,new}MovedAlternative'. The change between +`zebra`:: + Blocks of moved text are detected as in `blocks` mode. The blocks + are painted using either the `color.diff.(old|new)Moved` color or + `color.diff.(old|new)MovedAlternative`. The change between the two colors indicates that a new block was detected. -dimmed-zebra:: - Similar to 'zebra', but additional dimming of uninteresting parts +`dimmed-zebra`:: + Similar to `zebra`, but additional dimming of uninteresting parts of moved code is performed. The bordering lines of two adjacent blocks are considered interesting, the rest is uninteresting. `dimmed_zebra` is a deprecated synonym. -- ---no-color-moved:: +`--no-color-moved`:: Turn off move detection. This can be used to override configuration settings. It is the same as `--color-moved=no`. ---color-moved-ws=:: +`--color-moved-ws=,...`:: This configures how whitespace is ignored when performing the move detection for `--color-moved`. ifdef::git-diff[] @@ -419,63 +420,62 @@ endif::git-diff[] These modes can be given as a comma separated list: + -- -no:: +`no`:: Do not ignore whitespace when performing move detection. -ignore-space-at-eol:: +`ignore-space-at-eol`:: Ignore changes in whitespace at EOL. -ignore-space-change:: +`ignore-space-change`:: Ignore changes in amount of whitespace. This ignores whitespace at line end, and considers all other sequences of one or more whitespace characters to be equivalent. -ignore-all-space:: +`ignore-all-space`:: Ignore whitespace when comparing lines. This ignores differences even if one line has whitespace where the other line has none. -allow-indentation-change:: +`allow-indentation-change`:: Initially ignore any whitespace in the move detection, then group the moved code blocks only into a block if the change in whitespace is the same per line. This is incompatible with the other modes. -- ---no-color-moved-ws:: +`--no-color-moved-ws`:: Do not ignore whitespace when performing move detection. This can be used to override configuration settings. It is the same as `--color-moved-ws=no`. ---word-diff[=]:: - Show a word diff, using the to delimit changed words. +`--word-diff[=]`:: By default, words are delimited by whitespace; see - `--word-diff-regex` below. The defaults to 'plain', and + `--word-diff-regex` below. The __ defaults to `plain`, and must be one of: + -- -color:: +`color`:: Highlight changed words using only colors. Implies `--color`. -plain:: - Show words as `[-removed-]` and `{+added+}`. Makes no +`plain`:: + Show words as ++[-removed-]++ and ++{+added+}++. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous. -porcelain:: +`porcelain`:: Use a special line-based format intended for script consumption. Added/removed/unchanged runs are printed in the usual unified diff format, starting with a `+`/`-`/` ` character at the beginning of the line and extending to the end of the line. Newlines in the input are represented by a tilde `~` on a line of its own. -none:: +`none`:: Disable word diff again. -- + Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled. ---word-diff-regex=:: - Use to decide what a word is, instead of considering +`--word-diff-regex=`:: + Use __ to decide what a word is, instead of considering runs of non-whitespace to be a word. Also implies `--word-diff` unless it was already enabled. + Every non-overlapping match of the - is considered a word. Anything between these matches is +__ is considered a word. Anything between these matches is considered whitespace and ignored(!) for the purposes of finding differences. You may want to append `|[^[:space:]]` to your regular expression to make sure that it matches all non-whitespace characters. @@ -490,20 +490,20 @@ linkgit:gitattributes[5] or linkgit:git-config[1]. Giving it explicitly overrides any diff driver or configuration setting. Diff drivers override configuration settings. ---color-words[=]:: +`--color-words[=]`:: Equivalent to `--word-diff=color` plus (if a regex was specified) `--word-diff-regex=`. endif::git-format-patch[] ---no-renames:: +`--no-renames`:: Turn off rename detection, even when the configuration file gives the default to do so. ---[no-]rename-empty:: +`--[no-]rename-empty`:: Whether to use empty blobs as rename source. ifndef::git-format-patch[] ---check:: +`--check`:: Warn if changes introduce conflict markers or whitespace errors. What are considered whitespace errors is controlled by `core.whitespace` configuration. By default, trailing whitespaces (including @@ -511,9 +511,9 @@ ifndef::git-format-patch[] that is immediately followed by a tab character inside the initial indent of the line are considered whitespace errors. Exits with non-zero status if problems are found. Not compatible - with --exit-code. + with `--exit-code`. ---ws-error-highlight=:: +`--ws-error-highlight=`:: Highlight whitespace errors in the `context`, `old` or `new` lines of the diff. Multiple values are separated by comma, `none` resets previous values, `default` reset the list to @@ -525,30 +525,30 @@ ifndef::git-format-patch[] endif::git-format-patch[] ---full-index:: +`--full-index`:: Instead of the first handful of characters, show the full pre- and post-image blob object names on the "index" line when generating patch format output. ---binary:: +`--binary`:: In addition to `--full-index`, output a binary diff that can be applied with `git-apply`. ifndef::git-format-patch[] Implies `--patch`. endif::git-format-patch[] ---abbrev[=]:: +`--abbrev[=]`:: Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header - lines, show the shortest prefix that is at least '' + lines, show the shortest prefix that is at least __ hexdigits long that uniquely refers the object. In diff-patch output format, `--full-index` takes higher precedence, i.e. if `--full-index` is specified, full blob names will be shown regardless of `--abbrev`. Non default number of digits can be specified with `--abbrev=`. --B[][/]:: ---break-rewrites[=[][/]]:: +`-B[][/]`:: +`--break-rewrites[=[][/]]`:: Break complete rewrite changes into pairs of delete and create. This serves two purposes: + @@ -556,22 +556,22 @@ It affects the way a change that amounts to a total rewrite of a file not as a series of deletion and insertion mixed together with a very few lines that happen to match textually as the context, but as a single deletion of everything old followed by a single insertion of -everything new, and the number `m` controls this aspect of the -B +everything new, and the number __ controls this aspect of the `-B` option (defaults to 60%). `-B/70%` specifies that less than 30% of the original should remain in the result for Git to consider it a total rewrite (i.e. otherwise the resulting patch will be a series of deletion and insertion mixed together with context lines). + -When used with -M, a totally-rewritten file is also considered as the -source of a rename (usually -M only considers a file that disappeared -as the source of a rename), and the number `n` controls this aspect of -the -B option (defaults to 50%). `-B20%` specifies that a change with +When used with `-M`, a totally-rewritten file is also considered as the +source of a rename (usually `-M` only considers a file that disappeared +as the source of a rename), and the number __ controls this aspect of +the `-B` option (defaults to 50%). `-B20%` specifies that a change with addition and deletion compared to 20% or more of the file's size are eligible for being picked up as a possible source of a rename to another file. --M[]:: ---find-renames[=]:: +`-M[]`:: +`--find-renames[=]`:: ifndef::git-log[] Detect renames. endif::git-log[] @@ -580,7 +580,7 @@ ifdef::git-log[] For following files across renames while traversing history, see `--follow`. endif::git-log[] - If `n` is specified, it is a threshold on the similarity + If __ is specified, it is a threshold on the similarity index (i.e. amount of addition/deletions compared to the file's size). For example, `-M90%` means Git should consider a delete/add pair to be a rename if more than 90% of the file @@ -590,12 +590,12 @@ endif::git-log[] the same as `-M5%`. To limit detection to exact renames, use `-M100%`. The default similarity index is 50%. --C[]:: ---find-copies[=]:: +`-C[]`:: +`--find-copies[=]`:: Detect copies as well as renames. See also `--find-copies-harder`. - If `n` is specified, it has the same meaning as for `-M`. + If __ is specified, it has the same meaning as for `-M`. ---find-copies-harder:: +`--find-copies-harder`:: For performance reasons, by default, `-C` option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command @@ -604,8 +604,8 @@ endif::git-log[] projects, so use it with caution. Giving more than one `-C` option has the same effect. --D:: ---irreversible-delete:: +`-D`:: +`--irreversible-delete`:: Omit the preimage for deletes, i.e. print only the header but not the diff between the preimage and `/dev/null`. The resulting patch is not meant to be applied with `patch` or `git apply`; this is @@ -617,7 +617,7 @@ endif::git-log[] When used together with `-B`, omit also the preimage in the deletion part of a delete/create pair. --l:: +`-l`:: The `-M` and `-C` options involve some preliminary steps that can detect subsets of renames/copies cheaply, followed by an exhaustive fallback portion that compares all remaining @@ -627,11 +627,11 @@ of a delete/create pair. destinations, this exhaustive check is O(N^2). This option prevents the exhaustive portion of rename/copy detection from running if the number of source/destination files involved - exceeds the specified number. Defaults to diff.renameLimit. + exceeds the specified number. Defaults to `diff.renameLimit`. Note that a value of 0 is treated as unlimited. ifndef::git-format-patch[] ---diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]:: +`--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]`:: Select only files that are Added (`A`), Copied (`C`), Deleted (`D`), Modified (`M`), Renamed (`R`), have their type (i.e. regular file, symlink, submodule, ...) changed (`T`), @@ -649,9 +649,9 @@ Also, these upper-case letters can be downcased to exclude. E.g. Note that not all diffs can feature all types. For instance, copied and renamed entries cannot appear if detection for those types is disabled. --S:: +`-S`:: Look for differences that change the number of occurrences of - the specified string (i.e. addition/deletion) in a file. + the specified __ (i.e. addition/deletion) in a file. Intended for the scripter's use. + It is useful when you're looking for an exact block of code (like a @@ -662,11 +662,11 @@ very first version of the block. + Binary files are searched as well. --G:: +`-G`:: Look for differences whose patch text contains added/removed - lines that match . + lines that match __. + -To illustrate the difference between `-S --pickaxe-regex` and +To illustrate the difference between `-S` `--pickaxe-regex` and `-G`, consider a commit with the following diff in the same file: + @@ -686,7 +686,7 @@ filter will be ignored. See the 'pickaxe' entry in linkgit:gitdiffcore[7] for more information. ---find-object=:: +`--find-object=`:: Look for differences that change the number of occurrences of the specified object. Similar to `-S`, just the argument is different in that it doesn't search for a specific string but for a specific @@ -695,25 +695,25 @@ information. The object can be a blob or a submodule commit. It implies the `-t` option in `git-log` to also find trees. ---pickaxe-all:: +`--pickaxe-all`:: When `-S` or `-G` finds a change, show all the changes in that changeset, not just the files that contain the change - in . + in __. ---pickaxe-regex:: - Treat the given to `-S` as an extended POSIX regular +`--pickaxe-regex`:: + Treat the __ given to `-S` as an extended POSIX regular expression to match. endif::git-format-patch[] --O:: +`-O`:: Control the order in which files appear in the output. This overrides the `diff.orderFile` configuration variable (see linkgit:git-config[1]). To cancel `diff.orderFile`, use `-O/dev/null`. + The output order is determined by the order of glob patterns in -. +__. All files with pathnames that match the first pattern are output first, all files with pathnames that match the second pattern (but not the first) are output next, and so on. @@ -724,7 +724,7 @@ If multiple pathnames have the same rank (they match the same pattern but no earlier patterns), their output order relative to each other is the normal order. + - is parsed as follows: +__ is parsed as follows: + -- - Blank lines are ignored, so they can be used as separators for @@ -738,106 +738,107 @@ the normal order. -- + Patterns have the same syntax and semantics as patterns used for -fnmatch(3) without the FNM_PATHNAME flag, except a pathname also +`fnmatch`(3) without the `FNM_PATHNAME` flag, except a pathname also matches a pattern if removing any number of the final pathname components matches the pattern. For example, the pattern "`foo*bar`" matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`". ---skip-to=:: ---rotate-to=:: - Discard the files before the named from the output +`--skip-to=`:: +`--rotate-to=`:: + Discard the files before the named __ from the output (i.e. 'skip to'), or move them to the end of the output (i.e. 'rotate to'). These options were invented primarily for the use of the `git difftool` command, and may not be very useful otherwise. ifndef::git-format-patch[] --R:: +`-R`:: Swap two inputs; that is, show differences from index or on-disk file to tree contents. endif::git-format-patch[] ---relative[=]:: ---no-relative:: +`--relative[=]`:: +`--no-relative`:: When run from a subdirectory of the project, it can be told to exclude changes outside the directory and show pathnames relative to it with this option. When you are not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative - to by giving a as an argument. + to by giving a __ as an argument. `--no-relative` can be used to countermand both `diff.relative` config option and previous `--relative`. --a:: ---text:: +`-a`:: +`--text`:: Treat all files as text. ---ignore-cr-at-eol:: +`--ignore-cr-at-eol`:: Ignore carriage-return at the end of line when doing a comparison. ---ignore-space-at-eol:: +`--ignore-space-at-eol`:: Ignore changes in whitespace at EOL. --b:: ---ignore-space-change:: +`-b`:: +`--ignore-space-change`:: Ignore changes in amount of whitespace. This ignores whitespace at line end, and considers all other sequences of one or more whitespace characters to be equivalent. --w:: ---ignore-all-space:: +`-w`:: +`--ignore-all-space`:: Ignore whitespace when comparing lines. This ignores differences even if one line has whitespace where the other line has none. ---ignore-blank-lines:: +`--ignore-blank-lines`:: Ignore changes whose lines are all blank. --I:: ---ignore-matching-lines=:: - Ignore changes whose all lines match . This option may + +`-I`:: +`--ignore-matching-lines=`:: + Ignore changes whose all lines match __. This option may be specified more than once. ---inter-hunk-context=:: - Show the context between diff hunks, up to the specified number +`--inter-hunk-context=`:: + Show the context between diff hunks, up to the specified __ of lines, thereby fusing hunks that are close to each other. Defaults to `diff.interHunkContext` or 0 if the config option is unset. --W:: ---function-context:: +`-W`:: +`--function-context`:: Show whole function as context lines for each change. The function names are determined in the same way as - `git diff` works out patch hunk headers (see 'Defining a - custom hunk-header' in linkgit:gitattributes[5]). + `git diff` works out patch hunk headers (see "Defining a + custom hunk-header" in linkgit:gitattributes[5]). ifndef::git-format-patch[] ifndef::git-log[] ---exit-code:: - Make the program exit with codes similar to diff(1). +`--exit-code`:: + Make the program exit with codes similar to `diff`(1). That is, it exits with 1 if there were differences and 0 means no differences. ---quiet:: +`--quiet`:: Disable all output of the program. Implies `--exit-code`. Disables execution of external diff helpers whose exit code is not trusted, i.e. their respective configuration option - `diff.trustExitCode` or `diff..trustExitCode` or + `diff.trustExitCode` or ++diff.++____++.trustExitCode++ or environment variable `GIT_EXTERNAL_DIFF_TRUST_EXIT_CODE` is false. endif::git-log[] endif::git-format-patch[] ---ext-diff:: +`--ext-diff`:: Allow an external diff helper to be executed. If you set an external diff driver with linkgit:gitattributes[5], you need to use this option with linkgit:git-log[1] and friends. ---no-ext-diff:: +`--no-ext-diff`:: Disallow external diff drivers. ---textconv:: ---no-textconv:: +`--textconv`:: +`--no-textconv`:: Allow (or disallow) external text conversion filters to be run when comparing binary files. See linkgit:gitattributes[5] for details. Because textconv filters are typically a one-way @@ -847,42 +848,42 @@ endif::git-format-patch[] linkgit:git-log[1], but not for linkgit:git-format-patch[1] or diff plumbing commands. ---ignore-submodules[=]:: - Ignore changes to submodules in the diff generation. can be - either "none", "untracked", "dirty" or "all", which is the default. - Using "none" will consider the submodule modified when it either contains - untracked or modified files or its HEAD differs from the commit recorded + +`--ignore-submodules[=(none|untracked|dirty|all)]`:: + Ignore changes to submodules in the diff generation. `all` is the default. + Using `none` will consider the submodule modified when it either contains + untracked or modified files or its `HEAD` differs from the commit recorded in the superproject and can be used to override any settings of the - 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When - "untracked" is used submodules are not considered dirty when they only + `ignore` option in linkgit:git-config[1] or linkgit:gitmodules[5]. When + `untracked` is used submodules are not considered dirty when they only contain untracked content (but they are still scanned for modified - content). Using "dirty" ignores all changes to the work tree of submodules, + content). Using `dirty` ignores all changes to the work tree of submodules, only changes to the commits stored in the superproject are shown (this was - the behavior until 1.7.0). Using "all" hides all changes to submodules. + the behavior until 1.7.0). Using `all` hides all changes to submodules. ---src-prefix=:: - Show the given source prefix instead of "a/". +`--src-prefix=`:: + Show the given source __ instead of "a/". ---dst-prefix=:: - Show the given destination prefix instead of "b/". +`--dst-prefix=`:: + Show the given destination __ instead of "b/". ---no-prefix:: +`--no-prefix`:: Do not show any source or destination prefix. ---default-prefix:: +`--default-prefix`:: Use the default source and destination prefixes ("a/" and "b/"). This overrides configuration variables such as `diff.noprefix`, `diff.srcPrefix`, `diff.dstPrefix`, and `diff.mnemonicPrefix` - (see `git-config`(1)). + (see linkgit:git-config[1]). ---line-prefix=:: - Prepend an additional prefix to every line of output. +`--line-prefix=`:: + Prepend an additional __ to every line of output. ---ita-invisible-in-index:: - By default entries added by "git add -N" appear as an existing - empty file in "git diff" and a new file in "git diff --cached". - This option makes the entry appear as a new file in "git diff" - and non-existent in "git diff --cached". This option could be +`--ita-invisible-in-index`:: + By default entries added by `git add -N` appear as an existing + empty file in `git diff` and a new file in `git diff --cached`. + This option makes the entry appear as a new file in `git diff` + and non-existent in `git diff --cached`. This option could be reverted with `--ita-visible-in-index`. Both options are experimental and could be removed in future. From patchwork Sat Nov 16 19:36:06 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila?= X-Patchwork-Id: 13877716 Received: from mail-wr1-f51.google.com (mail-wr1-f51.google.com [209.85.221.51]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DD66819308C for ; Sat, 16 Nov 2024 19:36:16 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.51 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731785778; cv=none; b=DmNqeehH9kWswpSCbgqa98zJjo5+LIn6BS2RQmlziS62Gvnj8VP7nkS3WXC09pdV12f9+WEPAoURtxzSDkZQJw85XS9tkg3Bx4y0U/WI2ul6RvYF3hSvz7viYDOsQQ344YWhyTbSbxOMUCeMSo9FiE8xmuqBd20mNlYvJdPjMCw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731785778; c=relaxed/simple; bh=pG6TIZ6xgd+s1fIdq8rfLkuWWrAPW2H9w5TlT5+aHZs=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=eqT8DsYvofXEQTpXpdlW2LLjnDm6m4JCBtfeQIoju5cYBguvkVluaTWGX5HlFchthPu41+KPPOT/182Oje4l5RPSoHn8mrwr/IMyZO1dp63Ozwqe2cg7uU5u048N1oXNBkh5UQVKFDgRSVBcc8U/wLatPuLmri0rpXwHh+U+E9U= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=QazmgDEX; arc=none smtp.client-ip=209.85.221.51 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="QazmgDEX" Received: by mail-wr1-f51.google.com with SMTP id ffacd0b85a97d-37d4b0943c7so1898098f8f.1 for ; Sat, 16 Nov 2024 11:36:16 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731785774; x=1732390574; darn=vger.kernel.org; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=JGYn9kokVEziW7GMIR8t/uCLNBW/YLPTAxPVqIWcoe8=; b=QazmgDEXda1WBbQZjWhC8d2kQEceeldrlL8N8jfgQYPVjbnVDSCzWdvZvBPOxPQ3Fd 6hXD8kxZ23N1tzVliDLMgw4CTVGqbWdy7J+2rCjf44uBH+2kuKEYEQzBqz57JEZLJ/Ur M2ygjz4o4hQcFt7unU74EyIuxOK3uSmKyiMwOoNsjZ7yJ53q3AlJ+pdhLTTOrrRcGBJ0 2U/cmCsT+QgYHQ3OjiKhnS9I/rSwheeCaFshaPEo/AL4sRD9r68AvYaqNRWs658gY10B ITrZMuxTJrEVPwUgCpAPbCtbtc20Fu8n8uuhqK//begpFnKN4lHDQ/5jBsrtmOWySITP 5Zlw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731785774; x=1732390574; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=JGYn9kokVEziW7GMIR8t/uCLNBW/YLPTAxPVqIWcoe8=; b=Jt2Dgg5miWMHwrj6a3HY0HYZ4LeQaEQ8ctHvDBhdKoIXJJplsjpMyvbQrxAtCw9wIN pt3B8Hk2QzQILxRh7CSqoEpK8PyBaS70dcH5RlgDTicfWgSnhkv3ydWvlpqu/jAlohOX Y2IoMQcTCRoxpZjpNBguuU15mnvob2rsFPf0fVNykR6LOseV2qc81DApUcsLfU1ueYYZ jtQiHm4Qb1isBDaQ08OEErwB19Ry0f2AmQ3rQoudBrVPnV07Tuo6TEdFa5BTy6ZIuYC/ eaRjYhuM6xmHXf52CrIhOEMqNw2QcyFl7Frqm0d1pa+Zqb8ZiiSrWqjSajGsVLhv5zSM eGfQ== X-Gm-Message-State: AOJu0Yzv/X2k4bCp+W3qdM51+3LIbLVGdUOMVCCbyVXjWqUn3zocQS+d 0zr2lT3s77EwbnawMrNAF3HWvqSEoLHFGPEzP4M5D88ToBerNTeUJIWQrg== X-Google-Smtp-Source: AGHT+IF7X2AYKSwj2ueYD/uzJn2zObwO6bZsWpMFhcjcdh165C8KIc783SuaW8eVIyWSa7FiLYd34A== X-Received: by 2002:a5d:59af:0:b0:382:3efc:c6d8 with SMTP id ffacd0b85a97d-3823efcc7e9mr517154f8f.12.1731785773665; Sat, 16 Nov 2024 11:36:13 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3821adad619sm7909470f8f.27.2024.11.16.11.36.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 Nov 2024 11:36:13 -0800 (PST) Message-Id: <698628e076bcbba2e0c5ec2758c2a31adf9c91b8.1731785769.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Sat, 16 Nov 2024 19:36:06 +0000 Subject: [PATCH v3 3/5] doc: git-diff: apply format changes to diff-format Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Johannes Sixt , Patrick Steinhardt , =?utf-8?q?Jean-No=C3=ABl?= Avila , =?utf-8?q?Jean-No?= =?utf-8?q?=C3=ABl_Avila?= From: =?utf-8?q?Jean-No=C3=ABl_Avila?= From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= Signed-off-by: Jean-Noël Avila --- Documentation/diff-format.txt | 42 +++++++++++++++++------------------ 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt index a3ae8747a22..c72fb379867 100644 --- a/Documentation/diff-format.txt +++ b/Documentation/diff-format.txt @@ -1,25 +1,25 @@ Raw output format ----------------- -The raw output format from "git-diff-index", "git-diff-tree", -"git-diff-files" and "git diff --raw" are very similar. +The raw output format from `git-diff-index`, `git-diff-tree`, +`git-diff-files` and `git diff --raw` are very similar. These commands all compare two sets of things; what is compared differs: -git-diff-index :: - compares the and the files on the filesystem. +`git-diff-index `:: + compares the __ and the files on the filesystem. -git-diff-index --cached :: - compares the and the index. +`git-diff-index --cached `:: + compares the __ and the index. -git-diff-tree [-r] [...]:: +`git-diff-tree [-r] [...]`:: compares the trees named by the two arguments. -git-diff-files [...]:: +`git-diff-files [...]`:: compares the index and the files on the filesystem. -The "git-diff-tree" command begins its output by printing the hash of +The `git-diff-tree` command begins its output by printing the hash of what is being compared. After that, all the commands print one output line per changed file. @@ -54,19 +54,19 @@ That is, from the left to the right: Possible status letters are: -- A: addition of a file -- C: copy of a file into a new one -- D: deletion of a file -- M: modification of the contents or mode of a file -- R: renaming of a file -- T: change in the type of the file (regular file, symbolic link or submodule) -- U: file is unmerged (you must complete the merge before it can +- `A`: addition of a file +- `C`: copy of a file into a new one +- `D`: deletion of a file +- `M`: modification of the contents or mode of a file +- `R`: renaming of a file +- `T`: change in the type of the file (regular file, symbolic link or submodule) +- `U`: file is unmerged (you must complete the merge before it can be committed) -- X: "unknown" change type (most probably a bug, please report it) +- `X`: "unknown" change type (most probably a bug, please report it) -Status letters C and R are always followed by a score (denoting the +Status letters `C` and `R` are always followed by a score (denoting the percentage of similarity between the source and target of the move or -copy). Status letter M may be followed by a score (denoting the +copy). Status letter `M` may be followed by a score (denoting the percentage of dissimilarity) for file rewrites. The sha1 for "dst" is shown as all 0's if a file on the filesystem @@ -86,7 +86,7 @@ verbatim and the line is terminated by a NUL byte. diff format for merges ---------------------- -"git-diff-tree", "git-diff-files" and "git-diff --raw" +`git-diff-tree`, `git-diff-files` and `git-diff --raw` can take `-c` or `--cc` option to generate diff output also for merge commits. The output differs from the format described above in the following way: @@ -128,7 +128,7 @@ other diff formats ------------------ The `--summary` option describes newly added, deleted, renamed and -copied files. The `--stat` option adds diffstat(1) graph to the +copied files. The `--stat` option adds `diffstat`(1) graph to the output. These options can be combined with other options, such as `-p`, and are meant for human consumption. From patchwork Sat Nov 16 19:36:07 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila?= X-Patchwork-Id: 13877718 Received: from mail-wr1-f42.google.com (mail-wr1-f42.google.com [209.85.221.42]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DCF5819CC2D for ; Sat, 16 Nov 2024 19:36:18 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.42 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731785780; cv=none; b=ddAmUbZolmDWCr7MBjqyQM9p/oAX36AXDQAZwhWQWLkL48VuJ6JYDS00Zu2QmybpegzJLNZ+gDftgvfPy8SQAmxu1dQVaoIkbgiuTxZj3ABSmQg49a/UgoJnwoh11p6n6bgyXmkAheWRP4oASqY94/hkjpow9ieHTQcPxJwrSL4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731785780; c=relaxed/simple; bh=0NYo/XYeH3+n/Qry/njTb1AtkwL6TFmD58G4xKjP9Tc=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=d87Sjrt8Hcd+nGrd6Umew3SssFDvrqOiO5tj9EDl2FnGSNnyg63gX+liTfuARUo81GhzX+g/8xZRXLc8H5Mv2ZK4Uwth/hyoY+07U5mE4rCdI7wGVt5eFgIPna8TrWO9BpipaOIIExVMMusyyWDwSxMKvzla4FK6iZY7nBzN99s= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=cMn8iYVZ; arc=none smtp.client-ip=209.85.221.42 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="cMn8iYVZ" Received: by mail-wr1-f42.google.com with SMTP id ffacd0b85a97d-38230ed9baeso806079f8f.1 for ; Sat, 16 Nov 2024 11:36:18 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731785776; x=1732390576; darn=vger.kernel.org; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=LhawjVpJghbDgtfyy8U3o7VjiknI4ER7dr7TL3PtJ38=; b=cMn8iYVZh/ZbH5T04cAJZHTTqzLxSi/K+CoYjEFSDTfIm3tYwHyKE3apPduCPuayEo cv0uclM1aRdLPCU3C5tt4Q9D3t9FUEmUTpgawCAAmwJnDfXYHoqpuJSPueoJP4F+SEae hfpZx2m9yIXBcw0ZcU/amT1ur1FFQFCJtQRwAfCW8GqWGacLfAK31ai8uS8CxlGpNafR 4o4v0hHGfq3KyQmLLUXfMYKU8Rz5e1lFFyA1Wx2D0nCoS+K/jb+7LMu3H+oTBWQZQ+dn AJb2/zS7+0bnF1zE33V8Bno7NZqX0BFcRWHr8sHnsjgRf8AOp44Ttu9FmqTuagY+mld+ +hLw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731785776; x=1732390576; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=LhawjVpJghbDgtfyy8U3o7VjiknI4ER7dr7TL3PtJ38=; b=ZwSywLhxVVqpSRF5ys/+ho5dhqw4fNH2CUNgf364WHjVrPPH+UAdEO9S/ZEfo56pmm Wrkippfmiu6rLM2OB7BToOzQmw0xjm5ENC5ARELvPu1ZJA1xdmKgWj21D8QNjz8hTYN3 pLjOyqFkbwJ0W8OTVPB3G/uEo9GYTLcGH/TGAtP2zsr/ltfI56atjMAf5B5b4pIrS6Ag FKlhl/v3MopxKT8xoQCMpYUgDdfI6kmd2jgdfinL9kcna/iOKT3PnHo/D6oVvWP/voBD +Qv2E86+2CGh2f6d06LLP4ho+wATkY3+YQlbvxDUOxjqUy7ModvXz1OfkzGT+yEu8iSa ipkA== X-Gm-Message-State: AOJu0Yw2LWH8u3h82MwYwk/Q+pgziwb6S4r2ruLh1XfNhpZD5IlkHxXy HXQHwHmAhvZ0i0OrZqDoRKzN6OLw6Reo3mlt5Ty6o03uh/ccu6PGc1J3sA== X-Google-Smtp-Source: AGHT+IENQIh27ePwFshDjtRWfj70G4GNTERJg0ghybPGsxHBdARWRyhfU3XwbFNc02bDmaR/8HtD1g== X-Received: by 2002:a5d:6c65:0:b0:37d:4ebe:1650 with SMTP id ffacd0b85a97d-38225a922ddmr6767710f8f.46.1731785776085; Sat, 16 Nov 2024 11:36:16 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3824038beb6sm471904f8f.80.2024.11.16.11.36.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 Nov 2024 11:36:14 -0800 (PST) Message-Id: <1154462f8bea8110afcf8a71bb5cdb3d040eb1ab.1731785769.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Sat, 16 Nov 2024 19:36:07 +0000 Subject: [PATCH v3 4/5] doc: git-diff: apply format changes to diff-generate-patch Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Johannes Sixt , Patrick Steinhardt , =?utf-8?q?Jean-No=C3=ABl?= Avila , =?utf-8?q?Jean-No?= =?utf-8?q?=C3=ABl_Avila?= From: =?utf-8?q?Jean-No=C3=ABl_Avila?= From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= Signed-off-by: Jean-Noël Avila --- Documentation/diff-generate-patch.txt | 44 ++++++++++++++------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt index 4b5aa5c2e04..e5c813c96f3 100644 --- a/Documentation/diff-generate-patch.txt +++ b/Documentation/diff-generate-patch.txt @@ -14,7 +14,7 @@ You can customize the creation of patch text via the `GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables (see linkgit:git[1]), and the `diff` attribute (see linkgit:gitattributes[5]). -What the -p option produces is slightly different from the traditional +What the `-p` option produces is slightly different from the traditional diff format: 1. It is preceded by a "git diff" header that looks like this: @@ -30,20 +30,21 @@ name of the source file of the rename/copy and the name of the file that the rename/copy produces, respectively. 2. It is followed by one or more extended header lines: - - old mode - new mode - deleted file mode - new file mode - copy from - copy to - rename from - rename to - similarity index - dissimilarity index - index .. + -File modes are printed as 6-digit octal numbers including the file type +[synopsis] +old mode +new mode +deleted file mode +new file mode +copy from +copy to +rename from +rename to +similarity index +dissimilarity index +index .. ++ +File modes __ are printed as 6-digit octal numbers including the file type and file permission bits. + Path names in extended headers do not include the `a/` and `b/` prefixes. @@ -56,7 +57,7 @@ files, while 100% dissimilarity means that no line from the old file made it into the new one. + The index line includes the blob object names before and after the change. -The is included if the file mode does not change; otherwise, +The __ is included if the file mode does not change; otherwise, separate lines indicate the old and the new mode. 3. Pathnames with "unusual" characters are quoted as explained for @@ -134,17 +135,18 @@ or like this (when the `--cc` option is used): 2. It is followed by one or more extended header lines (this example shows a merge with two parents): - - index ,.. - mode ,.. - new file mode - deleted file mode , ++ +[synopsis] +index ,.. +mode ,`..` +new file mode +deleted file mode , + The `mode ,..` line appears only if at least one of the is different from the rest. Extended headers with information about detected content movement (renames and copying detection) are designed to work with the diff of two - and are not used by combined diff format. +__ and are not used by combined diff format. 3. It is followed by a two-line from-file/to-file header: From patchwork Sat Nov 16 19:36:08 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Jean-No=C3=ABl_Avila?= X-Patchwork-Id: 13877719 Received: from mail-wr1-f48.google.com (mail-wr1-f48.google.com [209.85.221.48]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id EA60D1A3BA1 for ; Sat, 16 Nov 2024 19:36:19 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.48 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731785782; cv=none; b=Ux19+0YYKjkW8Vo+sJIdvE8b4N1PSjy21RB4421K8RxzPPsvYo0SL/CP/vGxQSgVcAor2pQ4P9sRV9SI6W8nYfAowc6N547ZQ9PMMVYu8LVj7Q9rDWS7kZ4emcsDwTr1rSIW8Ns50BrQqJT8VhgQaOYFKHGiti91x9ByOuLBSPA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731785782; c=relaxed/simple; bh=eQaEgQYeAqAI9z/Ci4lldUMZfuqLo3ac4TPkBRZHgAc=; h=Message-Id:In-Reply-To:References:From:Date:Subject:MIME-Version: Content-Type:To:Cc; b=BDPTilxvF+IhnF6L//qIom98Byv+h4pkIeBwZpzA0DbmiNYk0DG8GlBmY+aPI5vYAvw03ifsZcTKjp+QCWObL+T1Qh0RmCpp8O831aqvgWIH0ox4vVFCCOuiYA85hsu7niC5S0cPJnU2GXbTStWC0dcn7OLUqE4CDaEzlwdIX5Y= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=WiGb0LsG; arc=none smtp.client-ip=209.85.221.48 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="WiGb0LsG" Received: by mail-wr1-f48.google.com with SMTP id ffacd0b85a97d-3822ba3cdbcso987273f8f.0 for ; Sat, 16 Nov 2024 11:36:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731785778; x=1732390578; darn=vger.kernel.org; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=JhumRkH1SLeEL/3fwKGELzg0e35VskpZ+nrbAYgQBGk=; b=WiGb0LsG1nWUh7KdcNJ46cliRS8Gf2A+t9ET2qagd+Ts2MEoS0mJQcLl/re5TZa1Ie QBfSi9aEFlKqm0xZPVEtc2+QkKGy0+BvqACCVDl+b7ZVLL+DXsMtNcgL20kKVMINDBE6 0T25gH0QEG0aUlsJBAhjbEg0mOpOFLcDKLzBcmG+izUqokqTwfJDBxPWvh6+EyOIeop1 /QCudpwC/xxXw1nunfVkbCVDBTc3WWYJtWNEWZRgAmpLqXGDiKbl7NoBBn8iv02PJYT9 gpXDrgf0b9OZYf7BQ+3NdTytptAOvU7CFA0N0sqKw4GHQtuAiXV+AhG8MjxNucFbGzKj CNUg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731785778; x=1732390578; h=cc:to:fcc:content-transfer-encoding:mime-version:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=JhumRkH1SLeEL/3fwKGELzg0e35VskpZ+nrbAYgQBGk=; b=Jj6hSnW0qxMLpZK3qkoeFL8ng9bNN54AEvlHkYhUmNful48u9+Zcsr67ta4LFARJTd sNcnpsmj2s4+wXuX1BWdW6TERJGOeAkI6y0IaBriGgm0Vpgc1Vw/cv52p39Xy3gtKyfF L9SpByYxs8Gi1MZ9n0trbQ1dnBHdb2G17CsnKkIouONdzYxAzRPx5UQZ73+/5Swx51KG jb1dsyX2Vep+qvtBE2YNZ5sNoQF/h0p3yypGcsWLUse2o5jyh4uhDez/Math48MFZexB YEDwEpkegX9Lh+oUDPCK9qaAwCqQPvadfj41IOKWciMAzFMoBzEczBIRvAAcfcR+TnuL ct+Q== X-Gm-Message-State: AOJu0YyaYK4q0iYsQSVFeq4qJsnqgcepjTaGiMB4otjb+Yrt+842H+cq Dhhf1gaAdy/XP9kAGT4tsLnGwUaDfkW9V1QO6cBMZen1MzuUlnrhgjo2lw== X-Google-Smtp-Source: AGHT+IE/+kbzY+Silk5tIoyg3qIMc4gGpHHodw6S40OLpbGHTc6quyJkglHwrSvvsB9IB+10vZJqjw== X-Received: by 2002:a05:6000:796:b0:37d:4744:9d1d with SMTP id ffacd0b85a97d-38225a39168mr5814269f8f.35.1731785777871; Sat, 16 Nov 2024 11:36:17 -0800 (PST) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3822f6afc20sm3960962f8f.81.2024.11.16.11.36.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 16 Nov 2024 11:36:16 -0800 (PST) Message-Id: <4ec2fd9c3c68163a358937498b523292c3d38465.1731785769.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Sat, 16 Nov 2024 19:36:08 +0000 Subject: [PATCH v3 5/5] doc: git-diff: apply format changes to config part Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fcc: Sent To: git@vger.kernel.org Cc: Johannes Sixt , Patrick Steinhardt , =?utf-8?q?Jean-No=C3=ABl?= Avila , =?utf-8?q?Jean-No?= =?utf-8?q?=C3=ABl_Avila?= From: =?utf-8?q?Jean-No=C3=ABl_Avila?= From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= By the way, we also change the sentences where git-diff would refer to itself, so that no link is created in the HTML output. Signed-off-by: Jean-Noël Avila --- Documentation/config/diff.txt | 204 ++++++++++++++++++---------------- 1 file changed, 111 insertions(+), 93 deletions(-) diff --git a/Documentation/config/diff.txt b/Documentation/config/diff.txt index 190bda17e51..45f3fe855c5 100644 --- a/Documentation/config/diff.txt +++ b/Documentation/config/diff.txt @@ -1,18 +1,25 @@ -diff.autoRefreshIndex:: - When using 'git diff' to compare with work tree +`diff.autoRefreshIndex`:: + When using `git diff` to compare with work tree files, do not consider stat-only changes as changed. Instead, silently run `git update-index --refresh` to update the cached stat information for paths whose contents in the work tree match the contents in the - index. This option defaults to true. Note that this - affects only 'git diff' Porcelain, and not lower level - 'diff' commands such as 'git diff-files'. + index. This option defaults to `true`. Note that this + affects only `git diff` Porcelain, and not lower level + `diff` commands such as `git diff-files`. -diff.dirstat:: +`diff.dirstat`:: +ifdef::git-diff[] + A comma separated list of `--dirstat` parameters specifying the + default behavior of the `--dirstat` option to `git diff` and friends. +endif::git-diff[] +ifndef::git-diff[] A comma separated list of `--dirstat` parameters specifying the default behavior of the `--dirstat` option to linkgit:git-diff[1] - and friends. The defaults can be overridden on the command line - (using `--dirstat=`). The fallback defaults + and friends. +endif::git-diff[] + The defaults can be overridden on the command line + (using `--dirstat=,...`). The fallback defaults (when not changed by `diff.dirstat`) are `changes,noncumulative,3`. The following parameters are available: + @@ -41,7 +48,7 @@ diff.dirstat:: Note that when using `cumulative`, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can be specified with the `noncumulative` parameter. -;; +__;; An integer parameter specifies a cut-off percent (3% by default). Directories contributing less than this percentage of the changes are not shown in the output. @@ -52,58 +59,58 @@ directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: `files,10,cumulative`. -diff.statNameWidth:: - Limit the width of the filename part in --stat output. If set, applies - to all commands generating --stat output except format-patch. +`diff.statNameWidth`:: + Limit the width of the filename part in `--stat` output. If set, applies + to all commands generating `--stat` output except `format-patch`. -diff.statGraphWidth:: - Limit the width of the graph part in --stat output. If set, applies - to all commands generating --stat output except format-patch. +`diff.statGraphWidth`:: + Limit the width of the graph part in `--stat` output. If set, applies + to all commands generating `--stat` output except `format-patch`. -diff.context:: - Generate diffs with lines of context instead of the default - of 3. This value is overridden by the -U option. +`diff.context`:: + Generate diffs with __ lines of context instead of the default + of 3. This value is overridden by the `-U` option. -diff.interHunkContext:: +`diff.interHunkContext`:: Show the context between diff hunks, up to the specified number of lines, thereby fusing the hunks that are close to each other. This value serves as the default for the `--inter-hunk-context` command line option. -diff.external:: +`diff.external`:: If this config variable is set, diff generation is not performed using the internal diff machinery, but using the - given command. Can be overridden with the `GIT_EXTERNAL_DIFF' + given command. Can be overridden with the `GIT_EXTERNAL_DIFF` environment variable. The command is called with parameters as described under "git Diffs" in linkgit:git[1]. Note: if you want to use an external diff program only on a subset of your files, you might want to use linkgit:gitattributes[5] instead. -diff.trustExitCode:: - If this boolean value is set to true then the +`diff.trustExitCode`:: + If this boolean value is set to `true` then the `diff.external` command is expected to return exit code 0 if it considers the input files to be equal or 1 if it - considers them to be different, like `diff(1)`. - If it is set to false, which is the default, then the command - is expected to return exit code 0 regardless of equality. + considers them to be different, like `diff`(1). + If it is set to `false`, which is the default, then the command + is expected to return exit code `0` regardless of equality. Any other exit code causes Git to report a fatal error. -diff.ignoreSubmodules:: - Sets the default value of --ignore-submodules. Note that this - affects only 'git diff' Porcelain, and not lower level 'diff' - commands such as 'git diff-files'. 'git checkout' - and 'git switch' also honor +`diff.ignoreSubmodules`:: + Sets the default value of `--ignore-submodules`. Note that this + affects only `git diff` Porcelain, and not lower level `diff` + commands such as `git diff-files`. `git checkout` + and `git switch` also honor this setting when reporting uncommitted changes. Setting it to - 'all' disables the submodule summary normally shown by 'git commit' - and 'git status' when `status.submoduleSummary` is set unless it is - overridden by using the --ignore-submodules command-line option. - The 'git submodule' commands are not affected by this setting. + `all` disables the submodule summary normally shown by `git commit` + and `git status` when `status.submoduleSummary` is set unless it is + overridden by using the `--ignore-submodules` command-line option. + The `git submodule` commands are not affected by this setting. By default this is set to untracked so that any untracked submodules are ignored. -diff.mnemonicPrefix:: - If set, 'git diff' uses a prefix pair that is different from the - standard "a/" and "b/" depending on what is being compared. When +`diff.mnemonicPrefix`:: + If set, `git diff` uses a prefix pair that is different from the + standard `a/` and `b/` depending on what is being compared. When this configuration is in effect, reverse diff output also swaps the order of the prefixes: `git diff`;; @@ -112,111 +119,117 @@ diff.mnemonicPrefix:: compares a (c)ommit and the (w)ork tree; `git diff --cached`;; compares a (c)ommit and the (i)ndex; -`git diff HEAD:file1 file2`;; +`git diff HEAD: `;; compares an (o)bject and a (w)ork tree entity; -`git diff --no-index a b`;; - compares two non-git things (1) and (2). +`git diff --no-index `;; + compares two non-git things __ and __. -diff.noPrefix:: - If set, 'git diff' does not show any source or destination prefix. +`diff.noPrefix`:: + If set, `git diff` does not show any source or destination prefix. -diff.srcPrefix:: - If set, 'git diff' uses this source prefix. Defaults to "a/". +`diff.srcPrefix`:: + If set, `git diff` uses this source prefix. Defaults to `a/`. -diff.dstPrefix:: - If set, 'git diff' uses this destination prefix. Defaults to "b/". +`diff.dstPrefix`:: + If set, `git diff` uses this destination prefix. Defaults to `b/`. -diff.relative:: - If set to 'true', 'git diff' does not show changes outside of the directory +`diff.relative`:: + If set to `true`, `git diff` does not show changes outside of the directory and show pathnames relative to the current directory. -diff.orderFile:: +`diff.orderFile`:: File indicating how to order files within a diff. - See the '-O' option to linkgit:git-diff[1] for details. +ifdef::git-diff[] + See the `-O` option for details. +endif::git-diff[] +ifndef::git-diff[] + See the `-O` option to linkgit:git-diff[1] for details. +endif::git-diff[] If `diff.orderFile` is a relative pathname, it is treated as relative to the top of the working tree. -diff.renameLimit:: +`diff.renameLimit`:: The number of files to consider in the exhaustive portion of - copy/rename detection; equivalent to the 'git diff' option + copy/rename detection; equivalent to the `git diff` option `-l`. If not set, the default value is currently 1000. This setting has no effect if rename detection is turned off. -diff.renames:: - Whether and how Git detects renames. If set to "false", - rename detection is disabled. If set to "true", basic rename - detection is enabled. If set to "copies" or "copy", Git will - detect copies, as well. Defaults to true. Note that this - affects only 'git diff' Porcelain like linkgit:git-diff[1] and +`diff.renames`:: + Whether and how Git detects renames. If set to `false`, + rename detection is disabled. If set to `true`, basic rename + detection is enabled. If set to `copies` or `copy`, Git will + detect copies, as well. Defaults to `true`. Note that this + affects only `git diff` Porcelain like linkgit:git-diff[1] and linkgit:git-log[1], and not lower level commands such as linkgit:git-diff-files[1]. -diff.suppressBlankEmpty:: +`diff.suppressBlankEmpty`:: A boolean to inhibit the standard behavior of printing a space - before each empty output line. Defaults to false. + before each empty output line. Defaults to `false`. -diff.submodule:: +`diff.submodule`:: Specify the format in which differences in submodules are - shown. The "short" format just shows the names of the commits - at the beginning and end of the range. The "log" format lists + shown. The `short` format just shows the names of the commits + at the beginning and end of the range. The `log` format lists the commits in the range like linkgit:git-submodule[1] `summary` - does. The "diff" format shows an inline diff of the changed - contents of the submodule. Defaults to "short". + does. The `diff` format shows an inline diff of the changed + contents of the submodule. Defaults to `short`. -diff.wordRegex:: +`diff.wordRegex`:: A POSIX Extended Regular Expression used to determine what is a "word" when performing word-by-word difference calculations. Character sequences that match the regular expression are "words", all other characters are *ignorable* whitespace. -diff..command:: +`diff..command`:: The custom diff driver command. See linkgit:gitattributes[5] for details. -diff..trustExitCode:: - If this boolean value is set to true then the +`diff..trustExitCode`:: + If this boolean value is set to `true` then the `diff..command` command is expected to return exit code 0 if it considers the input files to be equal or 1 if it - considers them to be different, like `diff(1)`. - If it is set to false, which is the default, then the command + considers them to be different, like `diff`(1). + If it is set to `false`, which is the default, then the command is expected to return exit code 0 regardless of equality. Any other exit code causes Git to report a fatal error. -diff..xfuncname:: +`diff..xfuncname`:: The regular expression that the diff driver should use to recognize the hunk header. A built-in pattern may also be used. See linkgit:gitattributes[5] for details. -diff..binary:: - Set this option to true to make the diff driver treat files as +`diff..binary`:: + Set this option to `true` to make the diff driver treat files as binary. See linkgit:gitattributes[5] for details. -diff..textconv:: +`diff..textconv`:: The command that the diff driver should call to generate the text-converted version of a file. The result of the conversion is used to generate a human-readable diff. See linkgit:gitattributes[5] for details. -diff..wordRegex:: +`diff..wordRegex`:: The regular expression that the diff driver should use to split words in a line. See linkgit:gitattributes[5] for details. -diff..cachetextconv:: - Set this option to true to make the diff driver cache the text +`diff..cachetextconv`:: + Set this option to `true` to make the diff driver cache the text conversion outputs. See linkgit:gitattributes[5] for details. include::../mergetools-diff.txt[] -diff.indentHeuristic:: +`diff.indentHeuristic`:: Set this option to `false` to disable the default heuristics that shift diff hunk boundaries to make patches easier to read. -diff.algorithm:: +`diff.algorithm`:: Choose a diff algorithm. The variants are as follows: + -- -`default`, `myers`;; +`default`;; +`myers`;; The basic greedy diff algorithm. Currently, this is the default. `minimal`;; Spend extra time to make sure the smallest possible diff is @@ -229,7 +242,7 @@ diff.algorithm:: -- + -diff.wsErrorHighlight:: +`diff.wsErrorHighlight`:: Highlight whitespace errors in the `context`, `old` or `new` lines of the diff. Multiple values are separated by comma, `none` resets previous values, `default` reset the list to @@ -238,14 +251,19 @@ diff.wsErrorHighlight:: The command line option `--ws-error-highlight=` overrides this setting. -diff.colorMoved:: - If set to either a valid `` or a true value, moved lines - in a diff are colored differently, for details of valid modes - see '--color-moved' in linkgit:git-diff[1]. If simply set to - true the default color mode will be used. When set to false, - moved lines are not colored. - -diff.colorMovedWS:: +`diff.colorMoved`:: + If set to either a valid __ or a `true` value, moved lines + in a diff are colored differently. +ifdef::git-diff[] + For details of valid modes see `--color-moved`. +endif::git-diff[] +ifndef::git-diff[] + For details of valid modes see `--color-moved` in linkgit:git-diff[1]. +endif::git-diff[] + If simply set to `true` the default color mode will be used. When + set to `false`, moved lines are not colored. + +`diff.colorMovedWS`:: When moved lines are colored using e.g. the `diff.colorMoved` setting, - this option controls the `` how spaces are treated. - For details of valid modes see '--color-moved-ws' in linkgit:git-diff[1]. + this option controls the mode how spaces are treated. + For details of valid modes see `--color-moved-ws` in linkgit:git-diff[1].