]> xenbits.xensource.com Git - people/liuw/libxenctrl-split/libvirt.git/commitdiff
docs: Mention repository locations in contributor guidelines
authorMartin Kletzander <mkletzan@redhat.com>
Tue, 21 Oct 2014 10:20:56 +0000 (12:20 +0200)
committerMartin Kletzander <mkletzan@redhat.com>
Tue, 21 Oct 2014 11:54:17 +0000 (13:54 +0200)
Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
HACKING
docs/hacking.html.in

diff --git a/HACKING b/HACKING
index add0841cb8d16a728fc4f03b246580bb7eee741d..f8546cb1b2c2f87f8ed2bc12ddca3fa34e15dda9 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -14,7 +14,11 @@ 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, with git rename detection enabled. You
+(2) Official upstream repository is kept in git ("git://libvirt.org/libvirt.git")
+and is browsable along with other libvirt-related repositories (e.g.
+libvirt-python) online <http://libvirt.org>.
+
+(3) Post patches in unified diff format, with git rename detection enabled. You
 need a one-time setup of:
 
   git config diff.renames true
@@ -66,7 +70,7 @@ though).
 
 
 
-(3) In your commit message, make the summary line reasonably short (60 characters
+(4) In your commit message, make the summary line reasonably short (60 characters
 is typical), followed by a blank line, followed by any longer description of
 why your patch makes sense. If the patch fixes a regression, and you know what
 commit introduced the problem, mentioning that is useful. If the patch
@@ -78,7 +82,7 @@ is up to you if you want to include or omit them in the commit message.
 
 
 
-(4) Split large changes into a series of smaller patches, self-contained if
+(5) 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. Moreover, please keep in mind that it's
 required to be able to compile cleanly (*including* "make check" and "make
@@ -89,10 +93,10 @@ things).
 
 
 
-(5) Make sure your patches apply against libvirt GIT. Developers only follow GIT
+(6) Make sure your patches apply against libvirt GIT. Developers only follow GIT
 and don't care much about released versions.
 
-(6) Run the automated tests on your code before submitting any changes. In
+(7) Run the automated tests on your code before submitting any changes. In
 particular, configure with compile warnings set to -Werror. This is done
 automatically for a git checkout; from a tarball, use:
 
@@ -138,7 +142,7 @@ various tests under gdb or Valgrind.
 
 
 
-(7) The Valgrind test should produce similar output to "make check". If the output
+(8) The Valgrind test should produce similar output to "make check". If the output
 has traces within libvirt API's, then investigation is required in order to
 determine the cause of the issue. Output such as the following indicates some
 sort of leak:
@@ -214,7 +218,7 @@ to "tests/.valgrind.supp" in order to suppress the warning:
 
 
 
-(8) Update tests and/or documentation, particularly if you are adding a new
+(9) Update tests and/or documentation, particularly if you are adding a new
 feature or changing the output of a program.
 
 
index 8f2b9d6ef4ebe9f0ad0cf9d43ae0645f4454f053..4ab01790f698c77f74ef184a24daa8a64a140064 100644 (file)
       <li>Discuss any large changes on the mailing list first.  Post patches
         early and listen to feedback.</li>
 
+      <li>Official upstream repository is kept in git
+        (<code>git://libvirt.org/libvirt.git</code>) and is browsable
+        along with other libvirt-related repositories
+        (e.g. libvirt-python) <a href="http://libvirt.org">online</a>.</li>
+
       <li><p>Post patches in unified diff format, with git rename
         detection enabled.  You need a one-time setup of:</p>
 <pre>