Updated license info in copyright docblocks

[fballiano]

All files start with this code:

/**
 * OpenMage
 * 
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/osl-3.0.php
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@magento.com so we can send you a copy immediately.

but I think that * NOTICE OF LICENSE is redundant and could be removed, sparing a lot of bytes.

I checked a few famous php projects on github and never found anything similar.

EDIT: after a comment from @kiatng I thought we could reduce that block even more (and spare some disk space) to

 * OpenMage
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.txt.
 * It is also available at https://opensource.org/license/osl-3-0-php

[fballiano]

the workflows break because too many files were changed, but if you check the diff https://github.com/OpenMage/magento-lts/pull/3120.diff you'll see there's nothing apart from the comment change

[splendidinternet]

ja, sure, claro.

[fballiano]

no comments? if @admins don't like this i'll close it, I really don't like when PRs get zero feedback from anyone.

[fballiano]

can I get some feedback by @elidrissidev @kiatng @addison74? thanks guys

[kiatng]

In addition, how about reduce it further from

 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/osl-3.0.php
 * If you did not receive a copy of the license and are unable to
 * ...

to just

 * It is also available through the world-wide-web at this URL:
 * https://github.com/OpenMage/magento-lts/

and remove the following lines about other ways to obtain the license.

[fballiano]

In addition, how about reduce it further from

 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/osl-3.0.php
 * If you did not receive a copy of the license and are unable to
 * ...

to just

 * It is also available through the world-wide-web at this URL:
 * https://github.com/OpenMage/magento-lts/

I'd leave the opensource.org link just for independentness (dunno if it's even a word) but I'd write It is also available at https://opensource.org/licenses/osl-3.0.php instead of through the world-wide-web (which seem a very outdated form of speech)

and remove the following lines about other ways to obtain the license.

I didn't want to change the text that much (licensing is always tricky) but... what the heck, it's about time we remove it, and I don't think it's against the license anyway.

[fballiano]

I've updated and reduced the block even more, also updating the links to the licenses (there were changed on the opensource.org website).

[justinbeaty]

I am good with the change, let's just make sure to have the commit message match the following regex. That is so the update-copyright.php script will not update all files due to this change only. So, "Updated copyright docblocks" would work.

/^(Add(ed)?|Update(d)?).*?Copyright/i

I verified by:

1. Check to see only comment lines were changed:

 git diff -U0 HEAD~2 | grep '^[+-]' | grep -Ev '^(--- a/|\+\+\+ b/)' | sort -u
- * https://opensource.org/licenses/afl-3.0.php
-// https://opensource.org/licenses/afl-3.0.php
- * https://opensource.org/licenses/osl-3.0.php
-# https://opensource.org/licenses/osl-3.0.php
- * If you did not receive a copy of the license and are unable to
-# If you did not receive a copy of the license and are unable to
-// If you did not receive a copy of the license and are unable to
+ * It is also available at https://opensource.org/license/afl-3-0-php
+// It is also available at https://opensource.org/license/afl-3-0-php
+ * It is also available at https://opensource.org/license/osl-3-0-php
+# It is also available at https://opensource.org/license/osl-3-0-php
- * It is also available through the world-wide-web at this URL:
-# It is also available through the world-wide-web at this URL:
-// It is also available through the world-wide-web at this URL:
- * obtain it through the world-wide-web, please send an email
-# obtain it through the world-wide-web, please send an email
-// obtain it through the world-wide-web, please send an email
- * to license@magento.com so we can send you a copy immediately.
-# to license@magento.com so we can send you a copy immediately.
-// to license@magento.com so we can send you a copy immediately.

2. Check to see we didn't miss anything:

git grep 'It is also available through the world-wide-web'
git grep 'license@magento.com'

[fballiano]

@justinbeaty can that be done when squashing and merging? I think so.

[justinbeaty]

@fballiano Yes for sure. Just wanted to make sure to mention it. Worst case scenario if the commit message didn't match one of the regexes, we just modify the update-copyright.php script to ignore that commit by hash or updated regex.

[fballiano]

@justinbeaty you're absolutely right cause I wouldn't have thought of that, could you directly send me a commit comment that I could use in case we get this approved?

[justinbeaty]

@fballiano something like one of these:

Update copyright docblocks
updated license info in copyright docblocks
update start of file to simplify copyright

Basically, start the commit message with the word update/updated and also use the word copyright in the message. Example: https://regex101.com/r/xye3Qw/1

[fballiano]

perfect, thank you!

[fballiano]

merged and v20ed, thanks everybody!