External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-10-03 04:45:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

General tips for contributing patches

Browse Source 
* HACKING: Added section "general tips for contributing patches"
	to this file.
This commit is contained in:
Richard W.M. Jones 2008-06-02 11:53:23 +00:00
parent f855e91f11
commit 4a9ebf7da7
2 changed files with 47 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ChangeLog
View File

@ -1,3 +1,9 @@
Mon Jun 2 12:52:00 BST 2008 Richard W.M. Jones <rjones@redhat.com>
General tips for contributing patches
* HACKING: Added section "general tips for contributing patches"
to this file.
Thu May 29 16:43:00 EST 2008 Daniel P. Berrange <berrange@redhat.com>
* autobuild.sh: Only run converage tests if lcov is installed

42
HACKING
View File

@ -2,6 +2,46 @@ Libvirt contributor guidelines
==============================
General tips for contributing patches
=====================================
(1) Discuss any large changes on the mailing list first. Post patches
early and listen to feedback.
(2) Post patches in unified diff format. A command similar to this
should work:
diff -urp libvirt.orig/ libvirt.modified/ > libvirt-myfeature.patch
or:
cvs diff -up > libvirt-myfeature.patch
(3) Split large changes into a series of smaller patches, self-contained
if possible, with an explanation of each patch and an explanation of how
the sequence of patches fits together.
(4) Make sure your patches apply against libvirt CVS. Developers
only follow CVS and don't care much about released versions.
(5) Run the automated tests on your code before submitting any changes.
In particular, configure with compile warnings set to -Werror:
./configure --enable-compile-warnings=error
and run the tests:
make check
make syntax-check
make -C tests valgrind
The latter test checks for memory leaks.
(6) Update tests and/or documentation, particularly if you are adding
a new feature or changing the output of a program.
Code indentation
================
Libvirt's C source code generally adheres to some basic code-formatting
@ -198,4 +238,4 @@ complexity it's best to stick to the following general plan for all
Of particular note: *DO NOT* include libvirt/libvirt.h or
libvirt/virterror.h. It is included by "internal.h" already and there
are some special reasons why you cannot include these files
explicitly.
explicitly.