'Update' file headers: license notices, \file and other minor changes #1793

rodolforg · 2020-10-19T21:28:21Z

The fixes/adaptations in source code file headers (check synfig-core/src/modules/lyr_std/freetime.cpp for example):

'Update' license notice as for that suggested by FSF
Remove $Id$ – useful in CVS/SVN era, not used since project migrated to Git
Fix incorrect filenames in \file doxygen command – it was added in some files, specially on ETL folder
Remove empty === N O T E S ========= sections of file headers.

The license notices were changed to follow the GNU suggestion of how to do it:
http://www.gnu.org/licenses/gpl-howto.html (section "The license notices").

I kept the indentation of each original header, although I don't see why use tabular here.

This file is part of Synfig.

Synfig 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 2 of the License, or
(at your option) any later version.

Synfig 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 Synfig.  If not, see <https://www.gnu.org/licenses/>.

morevnaproject

I have found small issue with repeated word. Please check my comment. ^__^

ETL/ETL/_angle.h

ghost · 2020-10-23T18:53:33Z

Congratulations 🎉. DeepCode analyzed your code in 18.71 seconds and we found no issues. Enjoy a moment of no bugs ☀️.

👉 View analysis in DeepCode’s Dashboard | Configure the bot

rodolforg · 2020-10-23T20:00:00Z

I have plans to some other minor changes in files headers.
Should I place them in other PR or include them into a single PR?

Remove $Id$ line - unused for the last years, when started to use git
Sort the #include in a more organized ways (like @Keyikedalube and @blackwarthog do)
- alphabetically
- separated by groups:
  - (equivalent .h)
  - C++ standards
  - Glibmm/Gtkmm
  - ETL
  - Synfig
  - SynfigStudio
I'd like to change the copyright list to reduce its verbose info in some case to a similar way Godot Engine does and Google proposes:

**	\legal
**	Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
**	Copyright (c) 2005-2020 The Synfig authors
// or
**	Copyright (c) 2005-2020 Synfig contributors (cf. AUTHORS.md)

ice0 · 2020-10-24T06:04:35Z

I think all header changes better to make in one PR, #include reorder in another.

morevnaproject · 2020-10-24T15:06:48Z

The PR is looks good now! I think it is ready to merge! ^__^

morevnaproject

Looks good!

morevnaproject · 2020-10-24T15:12:02Z

Remove $Id$ line - unused for the last years, when started to use git

I'd like to change the copyright list to reduce its verbose info in some case to a similar way Godot Engine does and Google proposes:

I agree, those header changes are good to go with single PR, and includes in separate one. ^_^

rodolforg · 2020-10-24T15:42:36Z

@morevnaproject @ice0

Any decision or other proposal for Copyright statements?

Replace non-original synfig authors with ** Copyright (c) 2005-2020 The Synfig authors
Replace non-original synfig authors with ** Copyright (c) 2005-2020 Synfig contributors (cf. AUTHORS.md)
Don't replace, but append ** Copyright (c) 2005-2020 The Synfig authors
Don't replace, but append ** Copyright (c) 2005-2020 Synfig contributors (cf. AUTHORS.md)
Don't touch it at all

The AUTHORS or AUTHORS.md file may begin with, as for Google suggestion,

# This is the list of [Project Name]'s significant contributors.
#
# This does not necessarily list everyone who has contributed code,
# especially since many employees of one corporation may be contributing.
# To see the full list of contributors, see the revision history in
# source control.

rodolforg · 2020-10-25T03:11:07Z

I (still?) didn't remove those lines from .sgml files in synfig-docs folder.

<!-- retain these comments for translator revision tracking -->
<!-- $Id$ -->

Maybe the entire folder should be deleted anyway.

rodolforg · 2020-11-05T22:50:02Z

I still will fix the \file and \brief doxygen commands "soon".

But I don't know what to do with copyright statements as I told here #1793 (comment) – if we'll do something about it. I think we should go for options 3 or 4, because probably we would need the explicit permission of the listed authors to remove their explicit names from there (some licenses require to retain the copyright notices – I'm not sure about GPLv2).
I allow to remove all my copyright statements on synfig project files :P

rodolforg · 2020-11-07T03:09:57Z

The fixes/adaptations until now (check synfig-core/src/synfig/cairo_operators.cpp for example):

'Update' license notice as for that suggested by FSF
Remove $Id$ – useful in CVS/SVN era, not used since project migrated to Git
Fix incorrect filenames in \file doxygen command – it was added in some files, specially on ETL folder
Fix contents of \brief, another doxygen command: most of cases used the Template brief file description, copied from… template file :P
Remove empty === N O T E S ========= sections of file headers.
Adapt copyright notice to simplify it and trust the copyright to git repository history, as a lot of opensource projects currently do (as Google ones and Godot Engine, for example)

The last one I need opinions from you @morevnaproject @ice0 (please see my previous posts).
The fourth item is a bit annoying/tedious to do :P

rodolforg · 2020-11-17T14:53:43Z

As I have no decision about copyright notices/authors, I'll stop this PR here.

ice0 · 2021-10-19T10:55:30Z

@morevnaproject @rodolforg
A lot of work has been done here so I think better to merge it as-is.

rodolforg · 2021-10-20T07:09:31Z

OK

morevnaproject · 2021-10-20T14:23:40Z

A lot of work has been done here so I think better to merge it as-is.

Absolutely agree ^__^

In order to follow GNU suggestion stated here: http://www.gnu.org/licenses/gpl-howto.html

It was useful and used in CVS and SVN ages, not in git. Those 'old' versioning systems replace the $Id$ with the current version id on checkout, but git doesn't do it.

and some respective \brief (error due to copy and paste) These are special commands for Doxygen documentation generator.

and set some \brief (already existent, but not annotated as so). These are special commands for Doxygen documentation generator.

It should be a file contents description, but they use the template file description

or replace it with \note doxygen command when not empty

rodolforg · 2021-10-26T01:17:57Z

Rebased then ;)

ice0 · 2021-10-26T04:13:53Z

Merged. Thank you!

rodolforg · 2021-10-27T00:27:34Z

Regarding the copyright statement, should we/I do something? XD

Any decision or other proposal for Copyright statements?

1. Replace non-original synfig authors with `**	Copyright (c) 2005-2020 The Synfig authors`

2. Replace non-original synfig authors with  `**	Copyright (c) 2005-2020 Synfig contributors (cf. AUTHORS.md)`

3. Don't replace, but append  `**	Copyright (c) 2005-2020 The Synfig authors`

4. Don't replace, but append  `**	Copyright (c) 2005-2020 Synfig contributors (cf. AUTHORS.md)`

5. Don't touch it at all

morevnaproject · 2021-11-01T12:02:21Z

I suggest to go with 4.
Opinions? ^__^

rodolforg · 2021-11-01T19:01:32Z

I'm okay with it.
But my cleanup-obsession wants to contact everyone to ask if we can remove their explicit name of per-file-copyright statement lol

morevnaproject · 2021-11-15T14:40:45Z

I think there is no harm if we leave their names in file.

But I do not mind if you will remove my name. ^__^

rodolforg · 2021-11-17T00:48:08Z

I don't care about mine too.

rodolforg marked this pull request as draft October 19, 2020 21:49

rodolforg force-pushed the some-file-header-fixes branch from 03d8eaa to 6b140fe Compare October 19, 2020 21:57

rodolforg marked this pull request as ready for review October 19, 2020 21:58

rodolforg force-pushed the some-file-header-fixes branch from 6b140fe to 41e4ae5 Compare October 19, 2020 22:34

ice0 requested a review from morevnaproject October 20, 2020 02:51

ice0 assigned morevnaproject Oct 20, 2020

morevnaproject added this to Waiting for test in Konstantin's Workspace Oct 20, 2020

morevnaproject requested changes Oct 23, 2020

View reviewed changes

ETL/ETL/_angle.h Show resolved Hide resolved

morevnaproject assigned rodolforg and unassigned morevnaproject Oct 23, 2020

morevnaproject moved this from Waiting for test to Check later in Konstantin's Workspace Oct 23, 2020

rodolforg force-pushed the some-file-header-fixes branch from 41e4ae5 to 861df8c Compare October 23, 2020 18:53

rodolforg mentioned this pull request Oct 23, 2020

Implemented canvasproperties dialog glade file #1577

Closed

morevnaproject self-requested a review October 24, 2020 15:06

morevnaproject previously approved these changes Oct 24, 2020

View reviewed changes

rodolforg force-pushed the some-file-header-fixes branch 2 times, most recently from d60015e to bfef733 Compare October 25, 2020 02:50

rodolforg marked this pull request as draft November 5, 2020 22:36

rodolforg force-pushed the some-file-header-fixes branch 2 times, most recently from 9a444eb to e31de4c Compare November 7, 2020 02:33

rodolforg added 13 commits October 25, 2021 22:04

change license notices of ETL file headers

14ffe4b

In order to follow GNU suggestion stated here: http://www.gnu.org/licenses/gpl-howto.html

change license notices of synfig-core file headers

99570ac

In order to follow GNU suggestion stated here: http://www.gnu.org/licenses/gpl-howto.html

change license notices of synfig-studio file headers

3f44473

In order to follow GNU suggestion stated here: http://www.gnu.org/licenses/gpl-howto.html

change license notices of autobuild script headers

1004588

In order to follow GNU suggestion stated here: http://www.gnu.org/licenses/gpl-howto.html

remove old $Id$ line from ETL file headers

1662643

It was useful and used in CVS and SVN ages, not in git. Those 'old' versioning systems replace the $Id$ with the current version id on checkout, but git doesn't do it.

remove old $Id$ line from synfig-core file headers

f8780a1

It was useful and used in CVS and SVN ages, not in git. Those 'old' versioning systems replace the $Id$ with the current version id on checkout, but git doesn't do it.

remove old $Id$ line from synfig-studio file headers

1378163

It was useful and used in CVS and SVN ages, not in git. Those 'old' versioning systems replace the $Id$ with the current version id on checkout, but git doesn't do it.

remove old $Id$ line from building system file headers

963e4d0

It was useful and used in CVS and SVN ages, not in git. Those 'old' versioning systems replace the $Id$ with the current version id on checkout, but git doesn't do it.

fix \file in file headers with wrong filenames in synfig-core

23ef28e

and some respective \brief (error due to copy and paste) These are special commands for Doxygen documentation generator.

fix \file in file headers with wrong filenames in synfig-studio

c4f070b

and some respective \brief (error due to copy and paste) These are special commands for Doxygen documentation generator.

fix/add \file in file headers with wrong filenames in ETL

da186ab

and set some \brief (already existent, but not annotated as so). These are special commands for Doxygen documentation generator.

fix some \brief for importer/exporter(target) module file headers

81d2cde

It should be a file contents description, but they use the template file description

remove empty === N O T E S === file header sections

2ce2609

or replace it with \note doxygen command when not empty

rodolforg force-pushed the some-file-header-fixes branch from 45ec289 to 2ce2609 Compare October 26, 2021 01:04

ice0 approved these changes Oct 26, 2021

View reviewed changes

ice0 merged commit 333182e into synfig:master Oct 26, 2021

ice0 added Code quality license labels Oct 26, 2021

rodolforg deleted the some-file-header-fixes branch October 26, 2021 11:49

morevnaproject removed this from Check later in Konstantin's Workspace Nov 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

'Update' file headers: license notices, \file and other minor changes #1793

'Update' file headers: license notices, \file and other minor changes #1793

rodolforg commented Oct 19, 2020 •

edited

morevnaproject left a comment

ghost commented Oct 23, 2020 •

edited by ghost

rodolforg commented Oct 23, 2020 •

edited

ice0 commented Oct 24, 2020

morevnaproject commented Oct 24, 2020

morevnaproject left a comment

morevnaproject commented Oct 24, 2020

rodolforg commented Oct 24, 2020

rodolforg commented Oct 25, 2020

rodolforg commented Nov 5, 2020

rodolforg commented Nov 7, 2020 •

edited

rodolforg commented Nov 17, 2020

ice0 commented Oct 19, 2021

rodolforg commented Oct 20, 2021

morevnaproject commented Oct 20, 2021

rodolforg commented Oct 26, 2021

ice0 commented Oct 26, 2021

rodolforg commented Oct 27, 2021

morevnaproject commented Nov 1, 2021

rodolforg commented Nov 1, 2021

morevnaproject commented Nov 15, 2021

rodolforg commented Nov 17, 2021

'Update' file headers: license notices, \file and other minor changes #1793

'Update' file headers: license notices, \file and other minor changes #1793

Conversation

rodolforg commented Oct 19, 2020 • edited

morevnaproject left a comment

Choose a reason for hiding this comment

ghost commented Oct 23, 2020 • edited by ghost

👉 View analysis in DeepCode’s Dashboard | Configure the bot

rodolforg commented Oct 23, 2020 • edited

ice0 commented Oct 24, 2020

morevnaproject commented Oct 24, 2020

morevnaproject left a comment

Choose a reason for hiding this comment

morevnaproject commented Oct 24, 2020

rodolforg commented Oct 24, 2020

rodolforg commented Oct 25, 2020

rodolforg commented Nov 5, 2020

rodolforg commented Nov 7, 2020 • edited

rodolforg commented Nov 17, 2020

ice0 commented Oct 19, 2021

rodolforg commented Oct 20, 2021

morevnaproject commented Oct 20, 2021

rodolforg commented Oct 26, 2021

ice0 commented Oct 26, 2021

rodolforg commented Oct 27, 2021

morevnaproject commented Nov 1, 2021

rodolforg commented Nov 1, 2021

morevnaproject commented Nov 15, 2021

rodolforg commented Nov 17, 2021

rodolforg commented Oct 19, 2020 •

edited

ghost commented Oct 23, 2020 •

edited by ghost

rodolforg commented Oct 23, 2020 •

edited

rodolforg commented Nov 7, 2020 •

edited