From: Johannes Sixt <j6t@kdbg.org>
To: Tom Russello <tom.russello@grenoble-inp.org>
Cc: git@vger.kernel.org, erwan.mathoniere@grenoble-inp.org,
matthieu.moy@grenoble-inp.fr, jordan.de-gea@grenoble-inp.org,
samuel.groot@grenoble-inp.org, gitster@pobox.com
Subject: Re: [PATCH v4 3/3] doc: more consistency in environment variables format
Date: Wed, 8 Jun 2016 08:56:52 +0200 [thread overview]
Message-ID: <5757C1B4.5060709@kdbg.org> (raw)
In-Reply-To: <20160607223507.18061-4-tom.russello@grenoble-inp.org>
Am 08.06.2016 um 00:35 schrieb Tom Russello:
> Wrap with backticks (monospaced font) unwrapped or single-quotes wrapped
> (italic type) environment variables which are followed by the word
> "environment". It was obtained with:
>
> perl -pi -e "s/\'?(\\\$?[0-9A-Z\_]+)\'?(?= environment ?)/\`\1\`/g" *.txt
>
> One of the main purposes is to stick to the CodingGuidelines as possible so
> that people writting new documentation by mimicking the existing are more likely
> to have it right (even if they didn't read the CodingGuidelines).
>
> Signed-off-by: Tom Russello <tom.russello@grenoble-inp.org>
> Signed-off-by: Erwan Mathoniere <erwan.mathoniere@grenoble-inp.org>
> Signed-off-by: Samuel Groot <samuel.groot@grenoble-inp.org>
> Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
> ---
> One reason behind the creation of this patch is that patch [2/3] led to minor
> inconsistencies in some sentences as it only deals with GIT_* environment
> variables and let others unchanged (for example `GIT_ASKPASS` and 'SSH_ASKPASS'
> in Documentation/config.txt).
>
> For this one, I had to manually change GIT_AUTHOR_DATE
> (Documentation/date-formats.txt - l.4) and GIT_EXTERNAL_DIFF
> (Documentation/diff-generate-patch.txt - l.9) as the perl command didn't manage
> these cases and so created minor inconsistencies.
This last paragraph should go into the commit message.
Also, you should investigate cases where "environment" is at the
beginning of a line, because then the variable name is most likely at
the end of the previous line. At the least, you missed an occurrence of
GIT_EXTERNAL_DIFF in diff-config.txt.
-- Hannes
next prev parent reply other threads:[~2016-06-08 6:57 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-18 15:58 [RFC/PATCH] Formatting variables in the documentation Tom Russello
2016-05-18 18:15 ` Jeff King
2016-05-23 16:00 ` Samuel GROOT
2016-05-23 17:57 ` Matthieu Moy
2016-05-26 4:36 ` Jeff King
2016-05-26 16:18 ` Junio C Hamano
2016-05-26 16:23 ` Jeff King
2016-05-26 16:37 ` Junio C Hamano
2016-05-26 16:39 ` Jeff King
2016-05-31 16:20 ` [PATCH] Documentation: bold literals in man Erwan Mathoniere
2016-06-03 22:08 ` [PATCH v2] Documentation more consistent Tom Russello
2016-06-03 22:08 ` [PATCH v2 1/3] Clearer rule about formatting literals Tom Russello
2016-06-03 22:08 ` [PATCH v2 2/3] Change environment variables format Tom Russello
2016-06-03 22:08 ` [PATCH v2 3/3] Change configuration " Tom Russello
2016-06-03 22:42 ` [PATCH v2] Documentation more consistent Junio C Hamano
2016-06-06 10:09 ` [PATCH v3] " Tom Russello
2016-06-06 10:09 ` [PATCH v3 1/3] doc: clearer rule about formatting literals Tom Russello
2016-06-06 13:36 ` Matthieu Moy
2016-06-06 13:42 ` Matthieu Moy
2016-06-06 15:38 ` Tom Russello
2016-06-06 10:09 ` [PATCH v3 2/3] doc: change environment variables format Tom Russello
2016-06-06 14:08 ` Matthieu Moy
2016-06-06 16:34 ` Tom Russello
2016-06-06 10:09 ` [PATCH v3 3/3] doc: change configuration " Tom Russello
2016-06-06 14:09 ` Matthieu Moy
2016-06-07 22:35 ` [PATCH v4 0/3] Documentation more consistent Tom Russello
2016-06-07 22:35 ` [PATCH v4 1/3] doc: clearer rule about formatting literals Tom Russello
2016-06-07 22:35 ` [PATCH v4 2/3] doc: change environment variables format Tom Russello
2016-06-07 22:35 ` [PATCH v4 3/3] doc: more consistency in " Tom Russello
2016-06-08 6:26 ` Matthieu Moy
2016-06-08 17:27 ` Tom Russello
2016-06-08 6:56 ` Johannes Sixt [this message]
2016-06-08 8:12 ` Matthieu Moy
2016-06-08 17:23 ` [PATCH v4 4/3] doc: change configuration " Tom Russello
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5757C1B4.5060709@kdbg.org \
--to=j6t@kdbg.org \
--cc=erwan.mathoniere@grenoble-inp.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jordan.de-gea@grenoble-inp.org \
--cc=matthieu.moy@grenoble-inp.fr \
--cc=samuel.groot@grenoble-inp.org \
--cc=tom.russello@grenoble-inp.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).