git-for-windows/git
1
0
Fork 0
mirror of https://github.com/git-for-windows/git.git synced 2025-12-12 04:41:35 -06:00
Code Issues Packages Projects Releases 335 Wiki Activity

SubmittingPatches: mention doc-diff

Browse Source 
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>
This commit is contained in:
Jeff King 2018-08-21 15:23:22 -04:00 committed by Junio C Hamano
parent beb188e22a
commit 7a76f5c611
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/SubmittingPatches
View File

@ -80,7 +80,9 @@ GitHub-Travis CI hints section for details.
Do not forget to update the documentation to describe the updated Do not forget to update the documentation to describe the updated
behavior and make sure that the resulting documentation set formats behavior and make sure that the resulting documentation set formats
well. It is currently a liberal mixture of US and UK English norms for well (try the Documentation/doc-diff script).
We currently have a liberal mixture of US and UK English norms for
spelling and grammar, which is somewhat unfortunate. A huge patch that spelling and grammar, which is somewhat unfortunate. A huge patch that
touches the files all over the place only to correct the inconsistency touches the files all over the place only to correct the inconsistency
is not welcome, though. Potential clashes with other changes that can is not welcome, though. Potential clashes with other changes that can

8
Documentation/doc-diff
View File

@ -1,4 +1,12 @@
#!/bin/sh #!/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="\ OPTIONS_SPEC="\
doc-diff [options] <from> <to> [-- <diff-options>] doc-diff [options] <from> <to> [-- <diff-options>]