mirror of
https://github.com/git/git.git
synced 2025-12-12 20:36:24 +01:00
227c4f33a0
The documentation is using the historical mode for titles, which is a setext-style (i.e., two-line) section title. The issue with this mode is that starting block delimiters (e.g., `----`) can be confused with a section title when they are exactly the same length as the preceding line. In the original documentation, this is taken care of for English by the writer, but it is not the case for translations where these delimiters are hidden. A translator can generate a line that is exactly the same length as the following block delimiter, which leads to this line being considered as a title. To safeguard against this issue, add a blank line before and after block delimiters where block is at root level, else add a "+" line before block delimiters to link it to the preceding paragraph. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
53 lines
1.3 KiB
Plaintext
53 lines
1.3 KiB
Plaintext
Tools for developing Git
|
|
========================
|
|
:sectanchors:
|
|
|
|
[[summary]]
|
|
== Summary
|
|
|
|
This document gathers tips, scripts, and configuration files to help people
|
|
working on Git's codebase use their favorite tools while following Git's
|
|
coding style.
|
|
|
|
[[author]]
|
|
=== Author
|
|
|
|
The Git community.
|
|
|
|
[[table_of_contents]]
|
|
== Table of contents
|
|
|
|
- <<vscode>>
|
|
- <<emacs>>
|
|
|
|
[[vscode]]
|
|
=== Visual Studio Code (VS Code)
|
|
|
|
The contrib/vscode/init.sh script creates configuration files that enable
|
|
several valuable VS Code features. See contrib/vscode/README.md for more
|
|
information on using the script.
|
|
|
|
[[emacs]]
|
|
=== Emacs
|
|
|
|
This is adapted from Linux's suggestion in its CodingStyle document:
|
|
|
|
- To follow the rules in CodingGuidelines, it's useful to put the following in
|
|
GIT_CHECKOUT/.dir-locals.el, assuming you use cperl-mode:
|
|
|
|
----
|
|
;; note the first part is useful for C editing, too
|
|
((nil . ((indent-tabs-mode . t)
|
|
(tab-width . 8)
|
|
(fill-column . 80)))
|
|
(cperl-mode . ((cperl-indent-level . 8)
|
|
(cperl-extra-newline-before-brace . nil)
|
|
(cperl-merge-trailing-else . t))))
|
|
----
|
|
|
|
For a more complete setup, since Git's codebase uses a coding style
|
|
similar to the Linux kernel's style, tips given in Linux's CodingStyle
|
|
document can be applied here too.
|
|
|
|
==== https://www.kernel.org/doc/html/v4.10/process/coding-style.html#you-ve-made-a-mess-of-it
|