Documentation/GettingStartedDevelopers: Difference between revisions

Revision as of 19:34, 5 January 2011

You want to contribute code, documentation or patches to QEMU?

Then...

... you should probably first join the mailing list.

Wiki

Create yourselves an account in the QEMU wiki.
Start with reading the QEMU wiki.
Contribute to the QEMU wiki by adding new topics or improving and expanding existing topics. It should help you and others in the future.

Documentation

Continue with reading the existing documentation.

Be prepared that all written documentation might be invalid - either because it is too old or because it was never correct. And it is never complete...

If you find bugs in the documentation then fix them and send patches to the mailing list. See Contribute/ReportABug.

Code

Run the QEMU system and user mode emulation for different targets (x86, mips, powerpc, ...).
QEMU has a lot of different parts (hardware device emulation, target emulation, code generation for different hosts, configuration, ...).

Choose an interesting part and concentrate on it for some time and read the code.

If you find bugs in the code, then fix them and send a patch to the mailing list. See Contribute/ReportABug.

Bugs

Read the Bug Tracker.
Check for topics in it for which you feel capable of handling and try to fix the issue. Send patches.

@@ Line 1: / Line 1: @@
 You want to contribute code, documentation or patches to QEMU?
-Then start reading the [[Manual|existing documentation]].
+Then...
+* ... you should probably first join the [[MailingLists|mailing list]].
-Some documentation can be built from QEMU sources in
+== Wiki ==
-several formats (HTML, PDF and others). A HTML version is here:
+* Create yourselves an account in the QEMU wiki.
+* Start with reading the QEMU wiki.
+* Contribute to the QEMU wiki by adding new topics or improving and expanding existing topics. It should help you and others in the future.
-* QEMU Emulator User Documentation (http://wiki.qemu.org/download/qemu-doc.html or http://www.weilnetz.de/qemu-doc.html)
+== Documentation ==
-* QEMU Internals (http://www.weilnetz.de/qemu-tech.html)
+* Continue with reading the [[Manual|existing documentation]].
+:Be prepared that all written documentation might be invalid - either because it is too old or because it was never correct. And it is never complete...
+* If you find bugs in the documentation then fix them and send patches to the mailing list. See [[Contribute/ReportABug]].
-Run QEMU system and user mode emulation for different targets
+== Code ==
-(x86, mips, powerpc, ...).
+* Run the QEMU system and user mode emulation for different targets (x86, mips, powerpc, ...).
+* QEMU has a lot of different parts (hardware device emulation, target emulation, code generation for different hosts, configuration, ...).
+:Choose an interesting part and concentrate on it for some time and read the code.
+* If you find bugs in the code, then fix them and send a patch to the mailing list. See [[Contribute/ReportABug]].
-QEMU has a lot of different parts (hardware device emulation,
+== Bugs ==
-target emulation, code generation for different hosts, configuration,
+* Read the Bug Tracker.
-...). Choose an interesting part. Beside the [[MailingLists|mailing list]],
+* Check for topics in it for which you feel capable of handling and try to fix the issue. Send patches.
-the documentation links above and perhaps the QEMU wiki,
-you will not find much written documentation - only the code.
-Be prepared that all written documentation might be invalid -
-either because it is too old or because it was never correct.
-And it is never complete...
-If you detect bugs in the documentation, you can fix them and
-send a patch to the mailing list. See [[Contribute/ReportABug]].
-You can also write documentation yourself in QEMU's wiki.
-Perhaps it will help you and others in the future.