[Lldb-commits] [lldb] [lldb][Docs] Document our major differences from the LLVM style (PR #66345)
Dave Lee via lldb-commits
lldb-commits at lists.llvm.org
Tue Sep 19 10:44:14 PDT 2023
================
@@ -18,19 +18,45 @@ Please refer to the `LLVM Developer Policy
authoring and uploading a patch. LLDB differs from the LLVM Developer
Policy in the following respects.
- - **Test infrastructure**: Like LLVM it is important to submit tests with your
- patches, but note that LLDB uses a different system for tests. Refer to the
- `test documentation <test.html>`_ for more details and the ``lldb/test``
- folder on disk for examples.
-
- - **Coding Style**: LLDB's code style differs from
- `LLVM's coding style <https://llvm.org/docs/CodingStandards.html>`_.
- Unfortunately there is no document describing the differences. Please be
- consistent with the existing code.
-
For anything not explicitly listed here, assume that LLDB follows the LLVM
policy.
+Coding Style
+++++++++++++
+
+LLDB's code style differs from `LLVM's coding style <https://llvm.org/docs/CodingStandards.html>`_
+in a few ways. The 2 main ones are:
+
+* `Variable and function naming <https://llvm.org/docs/CodingStandards.html#name-types-functions-variables-and-enumerators-properly>`_:
+
+ * Variables are ``snake_case``.
+
+ * Functions and methods are ``UpperCamelCase``.
+
+ * Static, global and member variables have ``s_``, ``g_`` and ``_m``
----------------
kastiglione wrote:
typo: `_m` should be `m_`.
https://github.com/llvm/llvm-project/pull/66345
More information about the lldb-commits
mailing list