diff options
| author |  Jeff King <peff@peff.net> | 2018-08-21 15:23:22 -0400 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2018-08-21 12:54:33 -0700 |
| commit | 7a76f5c611c25785cbb49374c04d366c274a3936 (patch) | |
| tree | afd1fca8c0cefc468b581f7285c7e1a2426ebc52 /Documentation/doc-diff | |
| parent | add a script to diff rendered documentation (diff) | |
| download | tgif-7a76f5c611c25785cbb49374c04d366c274a3936.tar.xz | |
SubmittingPatches: mention doc-diff
We already advise people to make sure their documentation
formats correctly. Let's point them at the doc-diff script,
which can help with that.
Let's also put a brief note in the script about its purpose,
since that otherwise can only be found in the original
commit message. Along with the existing -h/usage text,
that's hopefully enough for developers to make use of it.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/doc-diff')
| -rwxr-xr-x | Documentation/doc-diff | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/doc-diff b/Documentation/doc-diff index f483fe427c..6e285e648c 100755 --- a/Documentation/doc-diff +++ b/Documentation/doc-diff @@ -1,4 +1,12 @@ #!/bin/sh +# +# Build two documentation trees and diff the resulting formatted output. +# Compared to a source diff, this can reveal mistakes in the formatting. +# For example: +# +# ./doc-diff origin/master HEAD +# +# would show the differences introduced by a branch based on master. OPTIONS_SPEC="\ doc-diff [options] <from> <to> [-- <diff-options>] |