Home • Explore • Blog • CI
☰



git
1st chunk of `Documentation/ToolsForGit.adoc`
8ae4d59bbda1654c5de4fcec1206ddc64c96ad38d46a7bd60000000100000545
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
Title: Git Development Tools
Summary
This document provides tips and configurations for using various tools, such as Visual Studio Code and Emacs, to develop Git while following its coding style guidelines, including setup scripts and configuration files to enhance the development experience.