From: COGONI Guillaume <cogoni.guillaume@gmail.com>
To: gitster@pobox.com
Cc: cogoni.guillaume@gmail.com, derrickstolee@github.com,
git.jonathan.bressat@gmail.com, git@vger.kernel.org,
guillaume.cogoni@gmail.com, matthieu.moy@univ-lyon1.fr,
shaoxuan.yuan02@gmail.com
Subject: [PATCH v4 0/1] Documentation/ToolsForGit.txt: Tools for developing Git
Date: Thu, 21 Apr 2022 10:45:14 +0200 [thread overview]
Message-ID: <20220421084515.21236-1-cogoni.guillaume@gmail.com> (raw)
In-Reply-To: <xmqq35i7o3dk.fsf@gitster.g>
Hello,
Thanks for your review Junio C Hamano.
COGONI Guillaume (1):
Documentation/ToolsForGit.txt: Tools for developing Git
Documentation/CodingGuidelines | 16 +++--------
Documentation/Makefile | 1 +
Documentation/ToolsForGit.txt | 51 ++++++++++++++++++++++++++++++++++
3 files changed, 56 insertions(+), 12 deletions(-)
create mode 100644 Documentation/ToolsForGit.txt
Interdiff against v3:
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 509cd89aa2..4c756be517 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -43,7 +43,10 @@ the overall style of existing code. Modifications to existing
code is expected to match the style the surrounding code already
uses (even if it doesn't match the overall style of existing code).
-But if you must have a list of rules, here they are.
+But if you must have a list of rules, here are some language
+specific ones. Note that Documentation/ToolsForGit.txt document
+has a collection of tips to help you use some external tools
+to conform to these guidelines.
For shell scripts specifically (not exhaustive):
@@ -722,10 +725,3 @@ Writing Documentation:
inline substituted text+ instead of `monospaced literal text`, and with
the former, the part that should not get substituted must be
quoted/escaped.
-
-
-Documentation/ToolsForGit.txt:
-
- This document collects tips, scripts, and configuration files to help
- contributors working with the Git codebase use their favorite tools while
- following the Git coding style.
--
2.25.1
next prev parent reply other threads:[~2022-04-21 8:45 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-12 20:25 [PATCH 0/1] documentation: guide of best practices for GIT developer COGONI Guillaume
2022-04-12 20:25 ` [PATCH 1/1] " COGONI Guillaume
2022-04-13 14:36 ` [PATCH 0/1] " Shaoxuan Yuan
2022-04-13 16:36 ` Guillaume Cogoni
2022-04-16 12:34 ` [PATCH v1 0/1] Documentation/ToolsOnGit.txt: gather information about tools COGONI Guillaume
2022-04-16 12:34 ` [PATCH v1 1/1] " COGONI Guillaume
[not found] ` <63d7dc69656e47f7bc7bce4839711f32@SAMBXP02.univ-lyon1.fr>
2022-04-16 13:25 ` Matthieu Moy
2022-04-16 14:51 ` Philip Oakley
2022-04-16 17:11 ` Junio C Hamano
2022-04-17 9:35 ` [PATCH v2 0/1] Documentation/ToolsForGit.txt: Tools for developing Git COGONI Guillaume
2022-04-17 9:35 ` [PATCH v2 1/1] " COGONI Guillaume
[not found] ` <33d2087c66e44037b03db818dae60fea@SAMBXP02.univ-lyon1.fr>
2022-04-17 12:25 ` [PATCH v2 0/1] " Matthieu Moy
2022-04-20 13:06 ` [PATCH v3 " COGONI Guillaume
2022-04-20 13:06 ` [PATCH v3 1/1] " COGONI Guillaume
2022-04-20 21:23 ` Junio C Hamano
2022-04-21 8:45 ` COGONI Guillaume [this message]
2022-04-21 8:45 ` [PATCH v4 " COGONI Guillaume
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220421084515.21236-1-cogoni.guillaume@gmail.com \
--to=cogoni.guillaume@gmail.com \
--cc=derrickstolee@github.com \
--cc=git.jonathan.bressat@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=guillaume.cogoni@gmail.com \
--cc=matthieu.moy@univ-lyon1.fr \
--cc=shaoxuan.yuan02@gmail.com \
/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.
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 NNTP newsgroup(s).