Correct license info in file headers

Bug #1211621 reported by Kristina Hoeppner
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mahara
Fix Released
High
Robert Lyon

Bug Description

The license info currently reads:

----
* This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
----

To avoid any confusion, it should be corrected to read

----
* This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 or later of the License.
-----

The text appears as comment in probably pretty much every file in Mahara but also on the installation screen.

Tags: bite-sized
Changed in mahara:
assignee: Aaron Wells (u-aaronw) → nobody
assignee: nobody → Robert Lyon (robertl-9)
Revision history for this message
Kristina Hoeppner (kris-hoeppner) wrote :

We are going to make this change once we have all new files in Mahara, i.e. right before the release of RC 1.

We are going to do the following:

1. We have one file in Mahara that contains the copyright information. I would create LICENSE.txt.
2. Text as per below.
3. Each other file includes the following sentence at the top: For copyright information on Mahara, please see [path to the file].
4. We should also include two @ lines so that license and copyright information is properly picked up by documentation tools that can display such information. Check with Aaron who that might look like as he had a tool installed to check. I think it is the following two lines:

---
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
* @copyright For copyright information on Mahara, please see [path to the file]
---

3. If a file contains bits and pieces from someone else with different copyright, then that is added below our general copyright sentence directly in that one file.

================
Updated text for license page:

* Copyright (C) 2006-2013 Catalyst IT and others; see:
* http://wiki.mahara.org/Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3 or later of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see < http://www.gnu.org/licenses/>.
*
* @package mahara
* @subpackage core
* @author Catalyst IT
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
* @copyright (C) 2006-2013 Catalyst IT http://catalyst.net.nz

Revision history for this message
Kristina Hoeppner (kris-hoeppner) wrote :

Bob, the text on the installation screen will also need to change. It also has the (at your option).

Revision history for this message
Aaron Wells (u-aaronw) wrote :

We use PHPDoc tags in Mahara. The main tool for converting those into HTML these days is called phpDocumentor. There are a couple of tags for linking around to other places in the code, including "@see" and "inlink {@link}":

 - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.see.pkg.html

 - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.inlinelink.pkg.html

But, I don't think either of them will let you link to a non-PHP file like LICENSE. So we may as well just have the @copyright line read like this:

* @license http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
* @copyright For copyright information on Mahara, please see the LICENSE file distributed with this software.

Revision history for this message
Kristina Hoeppner (kris-hoeppner) wrote :

Sounds good to me.

Aaron Wells (u-aaronw)
Changed in mahara:
milestone: 1.8rc1 → 1.8.0
Revision history for this message
Aaron Wells (u-aaronw) wrote :

https://reviews.mahara.org/#/c/2538/ -- updating the license & copyright info in existing files with copyright info

and

https://reviews.mahara.org/#/c/2542/ -- adding license & copyright info to help HTML files

and

We also tried adding license info to the template files, but this caused problems so it wasn't merged. https://reviews.mahara.org/#/c/2541/

Changed in mahara:
status: Confirmed → Fix Committed
Aaron Wells (u-aaronw)
Changed in mahara:
status: Fix Committed → Fix Released
Revision history for this message
Kristina Hoeppner (kris-hoeppner) wrote :

FYI: We decided not to put the license info at the top of the template files because the information got printed and it's not necessary to have the license info on any file if we have it elsewhere.

Revision history for this message
Aaron Wells (u-aaronw) wrote :

That is to say, we tried adding the license info to template files inside of Dwoo comment tags:

 {* License goes here! *}

... but on some pages the comments actually got printed as part of the template instead of ignored like they're supposed to. Since it's not obligatory to print the license on top of every single file in a project, we decided it wasn't worth troubleshooting the issue and just left the license info off the template files.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.