This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
GDB attribution policy (Re: [PATCH v2 2/3] Add FreeBSD/mips architecture.)
- From: Pedro Alves <palves at redhat dot com>
- To: John Baldwin <jhb at FreeBSD dot org>, gdb-patches at sourceware dot org, binutils at sourceware dot org
- Date: Fri, 16 Dec 2016 12:22:40 +0000
- Subject: GDB attribution policy (Re: [PATCH v2 2/3] Add FreeBSD/mips architecture.)
- Authentication-results: sourceware.org; auth=none
- References: <20161206210015.40422-1-jhb@FreeBSD.org> <20161206210015.40422-3-jhb@FreeBSD.org>
Hi John,
On 12/06/2016 09:00 PM, John Baldwin wrote:
> --- /dev/null
> +++ b/gdb/mips-fbsd-tdep.c
> @@ -0,0 +1,565 @@
> +/* Target-dependent code for FreeBSD/mips.
> +
> + Copyright (C) 2016 Free Software Foundation, Inc.
> +
> + This software was developed by SRI International and the University
> + of Cambridge Computer Laboratory under DARPA/AFRL contract
> + FA8750-10-C-0237 ("CTSRD"), as part of the DARPA CRASH research
> + programme.
IMO, "contributed by" "written by", etc. attribution statements are best not
added to source files, and are better placed in the "Contributors" node in
the manual [1], which seems to exist exactly for this purpose.
I see a few advantages:
- It ends up surviving even if these new files are deleted in the future.
- It's discoverable by end users too, unlike some comment deep in some
source file.
- Doesn't get inaccurate over time, as other contributors touch / rework / add
to / mostly rewrite the code over the years, who understandably won't
remember or won't feel comfortable with touching the original "written by"
notes.
For similar reasons, a few years back, glibc explicitly stopped accepting
attribution statements in sources, as can be seen in their version of the
contribution checklist [2]. I believe the discussion that led to that glibc
policy started here [3].
I've discussed this with other GDB maintainers off list and it seems
there's general agreement to follow such a policy in GDB as well.
[1] - https://sourceware.org/gdb/current/onlinedocs/gdb/Contributors.html#Contributors
[2] - https://sourceware.org/glibc/wiki/Contribution%20checklist#Attribution
[3] - https://sourceware.org/ml/libc-alpha/2012-04/msg00339.html
Thanks,
Pedro Alves