public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Joel Brobecker <brobecker@adacore.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: gdb-patches@sourceware.org
Subject: Re: RFA: Using year ranges in copyright notices...
Date: Tue, 03 Jan 2012 08:53:00 -0000	[thread overview]
Message-ID: <20120103085234.GK2730@adacore.com> (raw)
In-Reply-To: <E1Rhxs0-00008Y-05@fencepost.gnu.org>

[-- Attachment #1: Type: text/plain, Size: 1189 bytes --]

> > A bit of a trivial question, but I wanted to be sure it's OK to do so.
> > I would like us to use address ranges in our copyright headers, instead
> > of explicitly listing each and every year.

Here is a patch for updating README to satisfy the requirements
in the GNU maintainers guide ("Information for Maintainers of GNU
Software").

I am assuming that it's trivial enough that no one will really object.
But if you do, please let me know! I do think it's for the better,
because some of these files are starting to have an awfully long list
of years...

I didn't make the same update in the gdbserver/README file, for two
reasons:
  - gdbserver/ is part of the GDB project;
  - The contents of gdbserver/README should be mostly inside
    either of the GDB manuals (Wiki entry in the "Project Ideas"
    added for that).

I put it at the end of the README because people wanting that
information will spend the effort of locating it. Most people,
I assume, are more interested in how to build GDB than what
a range of years in the copyright notice means precisely...

gdb/ChangeLog:

        * README (Copyright and License Notices): New section.

OK to commit?

Thanks,
-- 
Joel

[-- Attachment #2: readme.diff --]
[-- Type: text/x-diff, Size: 1446 bytes --]

commit 089b330595e021c7aad754210ac0f508d04d6f0a
Author: Joel Brobecker <brobecker@adacore.com>
Date:   Tue Jan 3 12:41:50 2012 +0400

    [README] Add not about copyright and license notices
    
    Also explain the use of year ranges in copyright notices.
    
    gdb/ChangeLog:
    
            * README (Copyright and License Notices): New section.

diff --git a/gdb/README b/gdb/README
index d79fecc..422551a 100644
--- a/gdb/README
+++ b/gdb/README
@@ -638,6 +638,28 @@ testsuite `standalone', without it being part of the GDB source tree.
 
 See the DejaGNU documentation for further details.
 
+
+Copyright and License Notices
+=============================
+
+Most files maintained by the GDB Project contain a copyright notice
+as well as a license notice, usually at the start of the file.  The
+copyright notice should list all the years during which nontrivial
+changes have been made to that file.
+
+To reduce the length of copyright notices, consecutive years in the
+copyright notice can be combined into a single range.  For instance,
+the following list of copyright years...
+
+    1986, 1988, 1989, 1991-1993, 1999, 2000, 2007, 2008, 2009, 2010, 2011
+
+... is abbreviated into:
+
+    1986, 1988-1989, 1991-1993, 1999-2000, 2007-2012
+
+Such ranges are used when nontrivial changes were made to that file
+each and every year in the range (inclusive).
+
 \f
 (this is for editing this file with GNU emacs)
 Local Variables:

  parent reply	other threads:[~2012-01-03  8:53 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-01-03  4:24 Joel Brobecker
2012-01-03  6:29 ` Eli Zaretskii
2012-01-03  6:58   ` Alfred M. Szmidt
2012-01-03  7:16     ` Joel Brobecker
2012-01-03  8:53   ` Joel Brobecker [this message]
2012-01-03  9:48     ` Yao Qi
2012-01-03 10:15       ` Joel Brobecker
2012-01-03 15:47         ` Joseph S. Myers
2012-01-03 16:02           ` Joel Brobecker
2012-01-03 17:53             ` Jan Kratochvil
2012-01-03 18:02               ` Joel Brobecker
2012-01-04  4:15                 ` Joel Brobecker
2012-01-04  5:22                   ` Eli Zaretskii
2012-01-03 10:59     ` Eli Zaretskii

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=20120103085234.GK2730@adacore.com \
    --to=brobecker@adacore.com \
    --cc=eliz@gnu.org \
    --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).