public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Pedro Alves <palves@redhat.com>
To: Joel Brobecker <brobecker@adacore.com>, gdb-patches@sourceware.org
Subject: Re: [RFC/RFA] gdb/CONTRIBUTE update (most of the info is now on our wiki)
Date: Mon, 18 Jan 2016 12:00:00 -0000	[thread overview]
Message-ID: <569CD3B8.1010008@redhat.com> (raw)
In-Reply-To: <1453019097-10519-1-git-send-email-brobecker@adacore.com>

On 01/17/2016 08:24 AM, Joel Brobecker wrote:
>  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
>  

Thanks a bunch for doing this.  It's been on my TODO for a long while
after this:

 https://sourceware.org/ml/gdb-patches/2014-10/msg00636.html

IMO, we'd keep this file even more minimal, and instead of having
it point to the wiki page here, it'd point to:

  https://sourceware.org/gdb/contribute/

(which is also linked from the main page)

and that page would be the one that would mention the wiki.

My main reason would that the the "contribute" page in the web site
would be the canonical entry point, while the wiki page is a fast
moving target.  E.g., it's growing past a checklist, so I wouldn't
be surprised if we end up splitting it into separate pages at some
point (and end up changing the URL).

But TBC, I'm definitely already happy with what you propose.

Thanks,
Pedro Alves

  reply	other threads:[~2016-01-18 12:00 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-01-17  8:25 Joel Brobecker
2016-01-18 12:00 ` Pedro Alves [this message]
2016-01-21 10:14   ` Joel Brobecker
2016-10-04 17:18     ` Pedro Alves

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=569CD3B8.1010008@redhat.com \
    --to=palves@redhat.com \
    --cc=brobecker@adacore.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).