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>
Jeff King committed
Aug 21, 2018 at 15:23 UTC
7a76f5c611c25785cbb49374c04d366c274a3936
2 files changed
+11
-1
Documentation/SubmittingPatches
+3
-1
@@ -80,7 +80,9 @@ GitHub-Travis CI hints section for details.
80
81
Do not forget to update the documentation to describe the updated
82
behavior and make sure that the resulting documentation set formats
83
-well. It is currently a liberal mixture of US and UK English norms for
83
+well (try the Documentation/doc-diff script).
84
+
85
+We currently have a liberal mixture of US and UK English norms for
86
spelling and grammar, which is somewhat unfortunate. A huge patch that
87
touches the files all over the place only to correct the inconsistency
88
is not welcome, though. Potential clashes with other changes that can
Documentation/doc-diff
+8
@@ -1,4 +1,12 @@
1
#!/bin/sh
2
+#
3
+# Build two documentation trees and diff the resulting formatted output.
4
+# Compared to a source diff, this can reveal mistakes in the formatting.
5
+# For example:
6
+#
7
+# ./doc-diff origin/master HEAD
8
+#
9
+# would show the differences introduced by a branch based on master.
10
11
OPTIONS_SPEC="\
12
doc-diff [options] <from> <to> [-- <diff-options>]