Re: [PATCH] Documentation: make formatting more consistent
From: Jeff King <hidden>
Date: 2016-06-15 23:07:14
On Wed, Nov 11, 2015 at 06:47:25PM +0300, Андрей Рыбак wrote:
Documentation/git.txt: enclose all Environment Variables in single quotes.
This tells "what", but we can already see that from the diff. The more interesting part is "why". Later you say:
Signed-off-by: Andrey Rybak <redacted> --- Documentation/git.txt is not consistent in the way it stylizes mentions of Environment Variables. Most of them are enclosed in single quotes, some are enclosed in backticks, some are not enclosed.
which I think is the more interesting bit, and should go into the commit message (but parts after the "---" generally do not). I've grabbed it manually in this case. I know we've discussed this particular spot before, and I think there may have been some disagreement about which style was the best. But since clearly no patch came out of the last discussion, and since an inconsistent set of styles is probably worse than consistent use of any of the choices, this makes sense to me as an incremental step. If we want to move to all-backticks (for example) later on, we can easily do so (or we can leave this as the final state).
quoted hunk ↗ jump to hunk
diff --git a/Documentation/git.txt b/Documentation/git.txt index c2e2a94..900272b 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt@@ -1056,7 +1056,7 @@ of clones and fetches. cloning of shallow repositories. See 'GIT_TRACE' for available trace output options.
Your patch seems whitespace-damaged (the leading tabs were converted to spaces). It was pretty easy to fix up in this case, so I did so (i.e., no need to re-send), but please check your mailer settings. Thanks. -Peff