From 94153862ab16e7745f4c17633416d41394b489c3 Mon Sep 17 00:00:00 2001 From: Andrea Bolognani Date: Mon, 6 Apr 2020 14:45:11 +0200 Subject: [PATCH] docs: Add programming-languages.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Most new contributors are probably going to modify existing code rather than introducing all-new programs and scripts, and even when the latter happen they'll hopefully get a feel for which programming languages are considered acceptable for the project by looking at what's already in the repo. Make this part less prominent by moving it to a separate page. Signed-off-by: Andrea Bolognani Reviewed-by: Daniel P. Berrangé --- docs/hacking.rst | 21 --------------------- docs/programming-languages.rst | 21 +++++++++++++++++++++ 2 files changed, 21 insertions(+), 21 deletions(-) create mode 100644 docs/programming-languages.rst diff --git a/docs/hacking.rst b/docs/hacking.rst index 356dbc506b..89f8f412c1 100644 --- a/docs/hacking.rst +++ b/docs/hacking.rst @@ -322,27 +322,6 @@ background reading on the subject, on `Richard Jones' guide to working with open source projects `__. -Language Usage -============== - -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. - Tooling ======= diff --git a/docs/programming-languages.rst b/docs/programming-languages.rst new file mode 100644 index 0000000000..9d7dbdcd37 --- /dev/null +++ b/docs/programming-languages.rst @@ -0,0 +1,21 @@ +===================== +Programming languages +===================== + +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.