[PULL,7/7] docs: move CODING_STYLE into the developer documentation

Message ID 20210224114926.6303-8-alex.bennee@linaro.org
State New
Headers show
  • testing updates (build, docs, dumps)
Related show

Commit Message

Alex Bennée Feb. 24, 2021, 11:49 a.m.
There is no particular reason to keep this on it's own in the root of
the tree. Move it into the rest of the fine developer manual and fixup
any links to it. The only tweak I've made is to fix the code-block
annotations to mention the language C.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

Reviewed-by: Claudio Fontana <cfontana@suse.de>

Message-Id: <20210223095931.16908-1-alex.bennee@linaro.org>



diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index 22854e334d..ae664da00c 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -14,6 +14,7 @@  Contents:
    :maxdepth: 2
+   style
diff --git a/CODING_STYLE.rst b/docs/devel/style.rst
similarity index 99%
rename from CODING_STYLE.rst
rename to docs/devel/style.rst
index 7bf4e39d48..8b0bdb3570 100644
--- a/CODING_STYLE.rst
+++ b/docs/devel/style.rst
@@ -641,7 +641,7 @@  trace-events style
 In trace-events files, use a '0x' prefix to specify hex numbers, as in:
-.. code-block::
+.. code-block:: c
     some_trace(unsigned x, uint64_t y) "x 0x%x y 0x" PRIx64
@@ -649,14 +649,14 @@  An exception is made for groups of numbers that are hexadecimal by
 convention and separated by the symbols '.', '/', ':', or ' ' (such as
 PCI bus id):
-.. code-block::
+.. code-block:: c
     another_trace(int cssid, int ssid, int dev_num) "bus id: %x.%x.%04x"
 However, you can use '0x' for such groups if you want. Anyway, be sure that
 it is obvious that numbers are in hex, ex.:
-.. code-block::
+.. code-block:: c
     data_dump(uint8_t c1, uint8_t c2, uint8_t c3) "bytes (in hex): %02x %02x %02x"
diff --git a/README.rst b/README.rst
index ce39d89077..91aa1e314c 100644
--- a/README.rst
+++ b/README.rst
@@ -66,7 +66,9 @@  When submitting patches, one common approach is to use 'git
 format-patch' and/or 'git send-email' to format & send the mail to the
 qemu-devel@nongnu.org mailing list. All patches submitted must contain
 a 'Signed-off-by' line from the author. Patches should follow the
-guidelines set out in the CODING_STYLE.rst file.
+guidelines set out in the `style section
+<https://www.qemu.org/docs/master/devel/style.html>` of
+the Developers Guide.
 Additional information on submitting patches can be found online via
 the QEMU website
diff --git a/scripts/fix-multiline-comments.sh b/scripts/fix-multiline-comments.sh
index 93f9b10669..c15a041272 100755
--- a/scripts/fix-multiline-comments.sh
+++ b/scripts/fix-multiline-comments.sh
@@ -1,6 +1,6 @@ 
 #! /bin/sh
-# Fix multiline comments to match CODING_STYLE
+# Fix multiline comments to match docs/devel/style.rst
 # Copyright (C) 2018 Red Hat, Inc.