This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[RFC/RFA] gdb/CONTRIBUTE update (most of the info is now on our wiki)


A new contributor mentioned that some of the info in gdb/CONTRIBUTE
was either out of date, or in contradiction with recommendations
we now make, iso I decided to review the contents of this file. That's
when I noticed that a lot of it is now available in the Contribution
Checklist wiki page, which we maintain more actively (also, the wiki
version has web-related features not available to plain-text files).
So, this patch updates the gdb/CONTRIBUTE file to correct/remove
information in favor of links to the Contribution Checklist online.

gdb/ChangeLog:

        * CONTRIBUTE: Adjust the reference to the Internal Manual,
        now part of the GDB Wiki.  Add reference to the Contribution
        Checklist, also in the GDB Wiki.  Remove several parts of
        this file, which are redundent with the the contents provided
        by the Contribution Checklist.

Thoughts? OK to commit?

Thanks,
-- 
Joel

---
 gdb/CONTRIBUTE | 109 +++++++--------------------------------------------------
 1 file changed, 13 insertions(+), 96 deletions(-)

diff --git a/gdb/CONTRIBUTE b/gdb/CONTRIBUTE
index 30f51cc..ddb436c 100644
--- a/gdb/CONTRIBUTE
+++ b/gdb/CONTRIBUTE
@@ -4,14 +4,20 @@
 GDB is a collaborative project and one which wants to encourage new
 development.  You may wish to fix GDB bugs, improve testing, port GDB
 to a new platform, update documentation, add new GDB features, and the
-like. To help with this, there is a lot of documentation
-available.. In addition to the user guide and internals manual
-included in the GDB distribution, the GDB web pages also contain much
-information.
+like. To help with this, there is a lot of documentation available.
+In addition to the user guide included in the GDB distribution,
+the GDB web pages also contain much information. The GDB Wiki, in
+particular, is where we collect and document a lot of information
+regarding the GDB development process:
 
-You may also want to submit your change so that can be considered for
-conclusion in a future version of GDB (see below).  Regardless, we
-encourage you to distribute the change yourself.
+        https://sourceware.org/gdb/wiki/
+
+You may also want to submit your change so they can be considered for
+inclusion in a future version of GDB (see below).  Regardless, we
+encourage you to distribute the change yourself.  To help you create
+high-quality contributions, we maintain a Contribution Checklist:
+
+        https://sourceware.org/gdb/wiki/ContributionChecklist
 
 If you don't feel up to hacking GDB, there are still plenty of ways to
 help!  You can answer questions on the mailing lists, write
@@ -54,92 +60,3 @@ o	Copyright Assignment
         on file.
 
 	Ref: http://www.gnu.org/prep/maintain.html#SEC6
-
-
-o	Submitting Patches
-
-	Every patch must have several pieces of information before we
-	can properly evaluate it.
-
-	A description of the bug and how your patch fixes this
-	bug. A reference to a testsuite failure is very helpful. For
-	new features a description of the feature and your
-	implementation.
-
-	A ChangeLog entry as plaintext (separate from the patch); see
-	the various ChangeLog files for format and content. Note that,
-	unlike some other projects, we do require ChangeLogs also for
-	documentation (i.e., .texi files).
-
-	The patch itself.  If you are accessing the git repository, use
-	"git diff", remembering first to update to the current master;
-	else, use "diff -up OLD NEW". If your version of diff does not
-	support these options, then get the latest version of GNU diff.
-
-	We accept patches as plain text (preferred for the compilers
-	themselves), MIME attachments (preferred for the web pages),
-	or as uuencoded gzipped text.
-
-	When you have all these pieces, bundle them up in a mail
-	message and send it to gdb-patches@sourceware.org. All
-	patches and related discussion should be sent to the
-	gdb-patches mailinglist. For further information on the GDB
-	git repository, see the Anonymous read-only git access and
-	Read-write git access page.
-
---
-
-Supplemental information for GDB:
-
-o	Please try to run the relevant testsuite before and after
-	committing a patch
-
-	If the contributor doesn't do it then the maintainer will.  A
-	contributor might include before/after test results in their
-	contribution.
-
-
-o	For bug fixes, please try to include a way of
-	demonstrating that the patch actually fixes something.
-
-	The best way of doing this is to ensure that the
-	testsuite contains one or more test cases that
-	fail without the fix but pass with the fix.
-
-	People are encouraged to submit patches that extend
-	the testsuite.
-
-
-o	Please read your patch before submitting it.
-
-	A patch containing several unrelated changes or
-	arbitrary reformats will be returned with a request
-	to re-formatting / split it.
-
-
-o	If ``gdb/configure.ac'' is modified then you don't
-	need to include patches to the regenerated file
-	``configure''.
-
-	The maintainer will re-generate those files
-	using autoconf (2.64 as of 2009-08-22).
-
-
-o	If ``gdb/gdbarch.sh'' is modified, you don't
-	need to include patches to the generated files
-	``gdbarch.h'' and ``gdbarch.c''.
-
-	See ``gdb/configure.ac'' above.
-
-
-o	When submitting a patch that fixes a bug
-	in GDB's bug database a brief reference
-	to the bug can be included in the ChangeLog
-	vis
-
-	* CONTRIBUTE: Mention PR convention.
-	Fix PR gdb/4705.
-
-	The text ``PR gdb/4705'' should also be included
-	in the git commit message.  That causes the
-	patch to automatically be archived with the PR.
-- 
2.5.0


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]