]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: Add programming-languages.rst
authorAndrea Bolognani <abologna@redhat.com>
Mon, 6 Apr 2020 12:45:11 +0000 (14:45 +0200)
committerAndrea Bolognani <abologna@redhat.com>
Wed, 8 Apr 2020 07:32:32 +0000 (09:32 +0200)
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 <abologna@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
docs/hacking.rst
docs/programming-languages.rst [new file with mode: 0644]

index 356dbc506b3c3ec58e773a294a55e3a1bc324c2f..89f8f412c1c17c90b12c079288a3892f6fc1c274 100644 (file)
@@ -322,27 +322,6 @@ background reading on the subject, on `Richard Jones' guide to
 working with open source
 projects <http://people.redhat.com/rjones/how-to-supply-code-to-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 (file)
index 0000000..9d7dbdc
--- /dev/null
@@ -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.