瀏覽代碼

docs: move CODING_STYLE into the developer documentation

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>
Alex Bennée 4 年之前
父節點
當前提交
93a1100768
共有 4 個文件被更改,包括 8 次插入5 次删除
  1. 3 1
      README.rst
  2. 1 0
      docs/devel/index.rst
  3. 3 3
      docs/devel/style.rst
  4. 1 1
      scripts/fix-multiline-comments.sh

+ 3 - 1
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
 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
 qemu-devel@nongnu.org mailing list. All patches submitted must contain
 a 'Signed-off-by' line from the author. Patches should follow the
 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
 Additional information on submitting patches can be found online via
 the QEMU website
 the QEMU website

+ 1 - 0
docs/devel/index.rst

@@ -14,6 +14,7 @@ Contents:
    :maxdepth: 2
    :maxdepth: 2
 
 
    build-system
    build-system
+   style
    kconfig
    kconfig
    testing
    testing
    fuzzing
    fuzzing

+ 3 - 3
CODING_STYLE.rst → 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:
 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
     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
 convention and separated by the symbols '.', '/', ':', or ' ' (such as
 PCI bus id):
 PCI bus id):
 
 
-.. code-block::
+.. code-block:: c
 
 
     another_trace(int cssid, int ssid, int dev_num) "bus id: %x.%x.%04x"
     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
 However, you can use '0x' for such groups if you want. Anyway, be sure that
 it is obvious that numbers are in hex, ex.:
 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"
     data_dump(uint8_t c1, uint8_t c2, uint8_t c3) "bytes (in hex): %02x %02x %02x"
 
 

+ 1 - 1
scripts/fix-multiline-comments.sh

@@ -1,6 +1,6 @@
 #! /bin/sh
 #! /bin/sh
 #
 #
-# Fix multiline comments to match CODING_STYLE
+# Fix multiline comments to match docs/devel/style.rst
 #
 #
 # Copyright (C) 2018 Red Hat, Inc.
 # Copyright (C) 2018 Red Hat, Inc.
 #
 #