]> git.lttng.org Git - lttng-tools.git/commitdiff
docs: Update coding standard blurb in contributions readme
authorKienan Stewart <kstewart@efficios.com>
Tue, 29 Oct 2024 12:48:45 +0000 (08:48 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Tue, 26 Nov 2024 19:30:29 +0000 (19:30 +0000)
Observed issue
==============

The CodingStyle document now includes style guidelines for Python,
Shell (bash), and legacy C code.

Solution
========

* Fix wording in the first sentence and use a relative link to the file
* Remove paragraph that other languages do not have a coding style
* Add a link to the test README

Known drawbacks
===============

None.

Change-Id: I057ae8d51afaa07892aa40b47c2f1716574b3b06
Signed-off-by: Kienan Stewart <kstewart@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
CONTRIBUTING.md

index fbb48cd5ee145f11ceff31910ead598524d6f26c..7ee115cbbd015df3860ccdb38b3c0f08bac3c145 100644 (file)
@@ -15,13 +15,9 @@ control. The upstream Git repository URL is:
 
 ## Coding standard
 
-See CodingStyle for guidelines style and design guidelines.
-
-Although the LTTng-tools code base is primarily written in C++, it does
-contain C, shell, and Python code as well. There is no official coding
-standard for these languages. However, using a style consistent with the
-rest of the code written in that language is strongly encouraged.
+See [CodingStyle](./CodingStyle.md) or style and design guidelines.
 
+See the [tests README](./tests/README.adoc) for test-related guidelines.
 
 ## Creating and sending a patch
 
This page took 0.029271 seconds and 4 git commands to generate.