ecbf3567e2
docs/devel/style: add a section about bitfield, and disallow them for packed structures
...
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org >
Reviewed-by: Richard Henderson <richard.henderson@linaro.org >
Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org >
Tested-by: Stefan Weil <sw@weilnetz.de >
Tested-by: Philippe Mathieu-Daudé <philmd@linaro.org >
Message-Id: <20250110203401.178532-3-pierrick.bouvier@linaro.org >
Signed-off-by: Alex Bennée <alex.bennee@linaro.org >
Message-Id: <20250116160306.1709518-25-alex.bennee@linaro.org >
2025-01-17 10:45:27 +00:00
4b77429adb
docs/style: permit inline loop variables
...
I've already wasted enough of my time debugging aliased variables in
deeply nested loops. While not scattering variable declarations around
is a good aim I think we can make an exception for stuff used inside a
loop.
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org >
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com >
Acked-by: Markus Armbruster <armbru@redhat.com >
Reviewed-by: Thomas Huth <thuth@redhat.com >
Reviewed-by: Richard Henderson <richard.henderson@linaro.org >
Signed-off-by: Alex Bennée <alex.bennee@linaro.org >
Message-Id: <20230829161528.2707696-5-alex.bennee@linaro.org >
2023-08-30 14:57:44 +01:00
7233bd1223
docs/devel: Fix coding style in style.rst
...
As defined earlier in this file, the opening curly brace of
functions should be placed on a separate line. So we should
do it in the examples here, too.
Fixes: 821f296756kkostiuk@redhat.com >
Message-Id: <20230710092638.161625-1-thuth@redhat.com >
Reviewed-by: Alex Bennée <alex.bennee@linaro.org >
Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com >
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org >
Reviewed-by: Markus Armbruster <armbru@redhat.com >
Signed-off-by: Thomas Huth <thuth@redhat.com >
2023-07-10 15:34:57 +02:00
ef46ae67ba
docs/style: call out the use of GUARD macros
...
There use makes our code safer so we should mention them.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org >
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org >
Reviewed-by: Juan Quintela <quintela@redhat.com >
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru >
Message-Id: <20230424092249.58552-19-alex.bennee@linaro.org >
2023-04-27 14:58:51 +01:00
067109a11c
docs/devel: mention the spacing requirement for QOM
...
We have a more complete document on QOM but we should at least mention
the style requirements in the style guide.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org >
Reviewed-by: Juan Quintela <quintela@redhat.com >
Reviewed-by: Mark Cave-Ayland <mark.cave-ayland@ilande.co.uk >
Message-Id: <20230424092249.58552-18-alex.bennee@linaro.org >
2023-04-27 14:58:51 +01:00
6a0057aa22
docs/devel: make a statement about includes
...
While not explicitly disallowing header macro abuse (because that
would make us hypocrites) lets at least address some things to think
about.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org >
Reviewed-by: Juan Quintela <quintela@redhat.com >
Message-Id: <20230424092249.58552-17-alex.bennee@linaro.org >
2023-04-27 14:58:46 +01:00
f07ceffdf5
docs/devel: Rules on #include in headers
...
Rules for headers were proposed a long time ago, and generally liked:
Message-ID: <87h9g8j57d.fsf@blackfin.pond.sub.org >
https://lists.nongnu.org/archive/html/qemu-devel/2016-03/msg03345.html
Wortk them into docs/devel/style.rst.
Suggested-by: Bernhard Beschow <shentey@gmail.com >
Signed-off-by: Markus Armbruster <armbru@redhat.com >
Message-Id: <20221222120813.727830-5-armbru@redhat.com >
Reviewed-by: Michael S. Tsirkin <mst@redhat.com >
Signed-off-by: Michael S. Tsirkin <mst@redhat.com >
Reviewed-by: Alex Bennée <alex.bennee@linaro.org >
Reviewed-by: Bernhard Beschow <shentey@gmail.com >
2023-01-08 01:54:22 -05:00
1812a2d366
doc/style: CLang -> Clang
...
It's not the way it is usually written (see https://clang.llvm.org/ ).
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com >
Reviewed-by: Damien Hedde <damien.hedde@greensocs.com >
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org >
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com >
Message-Id: <20220420132624.2439741-17-marcandre.lureau@redhat.com >
2022-04-21 17:03:51 +04:00
bda8bebad0
docs/devel: mention our .editorconfig
...
Ideally we should keep all our automatic formatting gubins in here.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org >
Reviewed-by: Richard Henderson <richard.henderson@linaro.org >
Tested-by: Philippe Mathieu-Daudé <f4bug@amsat.org >
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org >
Message-Id: <20220204204335.1689602-13-alex.bennee@linaro.org >
2022-02-09 12:08:42 +00:00
3918fe16b0
docs/devel: more documentation on the use of suffixes
...
Using _qemu is a little confusing. Let's use _compat for these sorts
of things. We should also mention _impl which is another common suffix
in the code base.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org >
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com >
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com >
Message-Id: <20220105135009.1584676-25-alex.bennee@linaro.org >
2022-01-18 16:42:42 +00:00
a68e025bf5
docs/devel: update C standard to C11
...
Since 8a9d3d5640alex.bennee@linaro.org >
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com >
Reviewed-by: Richard Henderson <richard.henderson@linaro.org >
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com >
Message-Id: <20220105135009.1584676-24-alex.bennee@linaro.org >
2022-01-18 16:42:42 +00:00
cd6b1674d6
docs: Fix botched rST conversion of 'submitting-a-patch.rst'
...
I completely botched up the merged[0] rST conversion of this document by
accidentally dropping entire hunks (!) of text. :-( I made it very hard
for reviewers to spot it, as the omitted text was buried deep in the
document. To fix my hatchet job, I reconverted the "SubmitAPatch"
wiki[1] page from scratch and replaced the existing rST with it, while
making sure I incorporated previous feedback.
In summary, in this reconverted edition:
- I did a careful (to the extent my eyes allowed) para-by-para
comparison of the wiki and the rST to make sure I didn't omit
anything accidentally.
- I made sure to work in the cosmetic feedback[2] that Thomas Huth
pointed out in the merged (and botched) edition:
- fix the hyperlinks in "Split up long patches"
- replace ".". with "does not end with a dot" (in "Write a meaningful
commit message" section)
- replace "---" with ``---`` so that it doesn't render as an em-dash
(there were two other occurrences; I fixed those too)
- Use "QEMU" spelling consistently in prose usage
- Add a consistent "refer to git-config" link where appropriate
Thanks to Thomas Huth and Alex Bennée for noticing it on IRC. And sorry
for my sloppiness.
Fixes: 9f73de8df0https://gitlab.com/qemu-project/qemu/-/commit/9f73de8df033
[1] https://wiki.qemu.org/index.php?title=Contribute/SubmitAPatch&oldid=10387
[2] https://lists.nongnu.org/archive/html/qemu-devel/2021-11/msg03600.html
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com >
Message-Id: <20211119193118.949698-2-kchamart@redhat.com >
Reviewed-by: Eric Blake <eblake@redhat.com >
[thuth: Some more cosmetical changes, fixed links from external to internal]
Signed-off-by: Thomas Huth <thuth@redhat.com >
2021-11-22 15:02:38 +01:00
5135fe7110
docs: Spell QEMU all caps
...
Replace Qemu -> QEMU.
Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com >
Reviewed-by: Darren Kenny <darren.kenny@oracle.com >
Reviewed-by: Markus Armbruster <armbru@redhat.com >
Message-Id: <20211118143401.4101497-1-philmd@redhat.com >
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com >
2021-11-19 10:16:58 +01:00
9fed69e1f6
docs/devel: expand style section of memory management
...
This aims to provide a bit more guidance for those who take on one of
our "clean up memory allocation" bite-sized tasks.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org >
Reviewed-by: Richard Henderson <richard.henderson@linaro.org >
Message-Id: <20210323165308.15244-4-alex.bennee@linaro.org >
2021-03-24 14:24:52 +00:00
93a1100768
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 >
2021-02-24 11:05:21 +00:00
