summaryrefslogtreecommitdiffstats
path: root/docs/code-quality/coding-style/coding_style_general.rst
blob: 950cd6ccd36e289934df51c489b9bca5c9e2073c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Mode line
~~~~~~~~~

Files should have Emacs and vim mode line comments as the first two
lines of the file, which should set ``indent-tabs-mode`` to ``nil``. For new
files, use the following, specifying two-space indentation:

.. code-block:: cpp

   /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   /* vim: set ts=2 et sw=2 tw=80: */
   /* This Source Code Form is subject to the terms of the Mozilla Public
    * License, v. 2.0. If a copy of the MPL was not distributed with this
    * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

Be sure to use the correct ``Mode`` in the first line, don't use ``C++`` in
JavaScript files.