[PATCH] doc: diff-options: clarify --relative option
In c0cb4a0679 `--relative` is given the option of specifying the path to be included in the diff output. This works by assigning the path as diff prefix. The documentation of `--relative` only mentions subdirectories, but in reality `--relative=foo` will happily display changes within the `foobar/` subdirectory or even the `foo-bar` file. Clarify the option a bit.
Signed-off-by: Han Young <hanyang.tony@bytedance.com>
---
Documentation/diff-options.txt | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 53ec3c9a34..b651e442b1 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -762,8 +762,9 @@ endif::git-format-patch[]
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 <path> as an argument.
+ can name which path to make the output relative
+ to by giving a <path> as an argument (e.g. `--relative=foo/`
+ will only show changes inside `foo` subdirectory).
`--no-relative` can be used to countermand both `diff.relative` config
option and previous `--relative`.
--
2.43.0
Han Young <hanyang.tony@bytedance.com>