Patchwork Replace contribution list in CONTRIBUTE file with wiki link

login
register
mail settings
Submitter Alan Hayward
Date Jan. 28, 2019, 10:02 a.m.
Message ID <6B530F52-3140-4AD8-A43D-544CF9240FFB@arm.com>
Download mbox | patch
Permalink /patch/31226/
State New
Headers show

Comments

Alan Hayward - Jan. 28, 2019, 10:02 a.m.
> On 26 Jan 2019, at 06:26, Joel Brobecker <brobecker@adacore.com> wrote:
> 
> FWIW, the proposed text with Pedro's comments looks good to me.
> Let me know when you have a final version you'd like me to push,
> and I will take care of it.
> 
> -- 
> Joel

GDB patch pushed (posted below).

Joel: for the webpage, could you update with the following, making sure to
replace all the [] with a link from the list (and the list itself deleted).
Thanks!


			Contributing to GDB

GDB is a collaborative project that relies on contributions.  You can help in this!  You may wish to fix bugs, improve testing, port GDB to a new platform, update documentation, add new features or optimizations, contribute to the mailing lists or official GDB website, etc.  We welcome all of the above and feel free to ask on the [GDB Mailing Lists] if you are looking for feedback or for people to review a work in progress.

To help with this, there is plenty of documentation available.  In addition to the [User Guide] and [Internals Manual] included in the GDB distribution, the [GDB Wiki] also contains substantial information.  If you are looking for a project then check the [Project Ideas] page.

If you write a change to the GDB codebase we encourage you to distribute the change yourself.  You may also want to submit your change so that can be considered for inclusion in a future version of GDB.  If so then there are certain legal requirements and style issues which all contributors need to be aware of - for more details please read the [Contribution Checklist].


[GDB Mailing Lists] https://sourceware.org/gdb/mailing-lists/
[User Guide] https://sourceware.org/gdb/current/onlinedocs/gdb/
[Internals Manual] https://sourceware.org/gdb/wiki/Internals
[GDB Wiki] https://sourceware.org/gdb/wiki/
[Project Ideas] https://sourceware.org/gdb/wiki/ProjectIdeas
[Contribution Checklist] https://sourceware.org/gdb/wiki/ContributionChecklist














    Replace contribution list in CONTRIBUTE file with wiki link

    The GDB wiki page has a much better contribution checklist than
    that in the GDB CONTRIBUTE file.  In addition, the wiki is easier
    to keep up to date with current processes.

    Reduce the CONTRIBUTE file down to a short paragraph followed by
    a link to the contribution process.  This also ensures anyone
    reading the CONTRIBUTE file for a given release has access to the
    latest processes.

    gdb/ChangeLog:

            * CONTRIBUTE: Replace contribution list with wiki link.
Pedro Alves - Jan. 28, 2019, 7:50 p.m.
On 01/28/2019 10:02 AM, Alan Hayward wrote:

> GDB patch pushed (posted below).
> 

Thanks!

> Joel: for the webpage, could you update with the following, making sure to
> replace all the [] with a link from the list (and the list itself deleted).
> Thanks!


> GDB is a collaborative project that relies on contributions.  You can help in this!  You may wish to fix bugs, improve testing, port 

I guess change that to "help with this" too, to match the gdb/CONTRIBUTE change:

> +GDB is a collaborative project that relies on contributions.  You can
> +help with this!  You may wish to fix bugs, improve testing, port GDB to

Thanks,
Pedro Alves
Joel Brobecker - Jan. 29, 2019, 5:33 a.m.
> Joel: for the webpage, could you update with the following, making sure to
> replace all the [] with a link from the list (and the list itself deleted).
> Thanks!

Thanks for taking the lead on getting this done, Alan.
I updated the "contributing" webpage with the text you provided
(modulo Pedro's tiny correction).

Patch

diff --git a/gdb/CONTRIBUTE b/gdb/CONTRIBUTE
index 30f51ccdc7..f7a4e5a30a 100644
--- a/gdb/CONTRIBUTE
+++ b/gdb/CONTRIBUTE
@@ -1,145 +1,13 @@ 

                        Contributing to GDB

-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.
+GDB is a collaborative project that relies on contributions.  You can
+help with this!  You may wish to fix bugs, improve testing, port GDB to
+a new platform, update documentation, add new features or optimizations,
+contribute to the mailing lists or official GDB website, etc.  We welcome
+all of the above and feel free to ask on the GDB mailing lists if you are
+looking for feedback or for people to review a work in progress.

-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.
+For more information see:

-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
-documentation, find bugs, create a GDB related website (contribute to
-the official GDB web site), or create a GDB related software
-package. We welcome all of the above and feel free to ask on the GDB
-mailing lists if you are looking for feedback or for people to review
-a work in progress.
-
-Ref: http://www.gnu.org/software/gdb/
-
-Finally, there are certain legal requirements and style issues which
-all contributors need to be aware of.
-
-o      Coding Standards
-
-       All contributions must conform to the GNU Coding Standard.
-       Submissions which do not conform to the standards will be
-       returned with a request to reformat the changes.
-
-       Ref: http://www.gnu.org/prep/standards_toc.html
-
-       GDB has certain additional coding requirements.  Those
-       requirements are explained in the GDB internals documentation.
-
-       Ref: http://sourceware.org/gdb/wiki/Internals%20Coding-Standards
-
-
-o      Copyright Assignment
-
-       Before we can accept code contributions from you, we need a
-       copyright assignment form filled out and filed with the FSF.
-
-       See some documentation by the FSF for details and contact us
-       (either via the GDB mailing list or the GDB maintainer that is
-       taking care of your contributions) to obtain the relevant
-       forms.
-
-        Small changes can be accepted without a copyright assignment form
-        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.
+https://sourceware.org/gdb/contribute/