From 44bf3bf3c58673f46982e10f8ac33a8e3a76dbd9 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Daniel=20P=2E=20Berrang=C3=A9?=
Date: Thu, 5 Sep 2019 12:41:30 +0100
Subject: [PATCH] docs: document that C & Python are the preferred languages
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit
Blacklist Perl and Shell code in favour of Python for
sake of readability and portability.
Reviewed-by: Ján Tomko
Signed-off-by: Daniel P. Berrangé
---
docs/hacking.html.in | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 90376968c3..edf2f54ce3 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -343,6 +343,36 @@
Richard Jones' guide to working with open source projects.
+
+
+
+ The libvirt repository makes use of a large number of programming
+ languages. It is anticipated that in the future libvirt will adopt
+ use of other new languages. To reduce the overall burden on developers,
+ there is thus a general desire to phase out usage of some of the
+ existing languages.
+
+
+
+ The preferred languages at this time are:
+
+
+
+ - C - for the main libvirt codebase. Dialect supported by
+ GCC/CLang only.
+ - Python - for supporting build scripts / tools. Code must
+ run with both version 2.7 and 3.x at this time.
+
+
+
+ Languages that should not be used for any new contributions:
+
+
+
+ - Perl - build scripts must be written in Python instead.
+ - Shell - build scripts must be written in Python instead.
+
+
--
2.47.2