Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

all: Use the name MicroPython consistently #3181

Closed

Conversation

webmeister
Copy link
Contributor

There were several different spellings of MicroPython present in the code,
when there should be only one.

@pfalcon
Copy link
Contributor

pfalcon commented Jun 30, 2017

The reason why this patch wasn't applied before is exactly because it's a sweeping change adding a lot git log -p/git blame noise. It definitely needs to be done for 2.0 with other sweeping changes, I'm not sure that time is now. But if it's done, this change should be combined with copyright year updates (and in that sense might be better done by a maintainer).

@webmeister
Copy link
Contributor Author

adding a lot git log -p/git blame noise

How does this negatively affect git blame? It mostly touches lines in the copyright comment block, that probably nobody will look at anyway. (But it would have helped me in #3180, to have an easy way to identify files belonging to MicroPython by searching for the string "MicroPython" in the first comment block.)

But if it's done, this change should be combined with copyright year updates

Is that really necessary, from a legal point of view, especially if the file has not been touched in recent years? If it is, then please do not delay applying this patch until the other changes are ready. Copyright years are in different lines than the MicroPython string, so the diff won't get any smaller.

At the moment, you have things like c408ed9 from just a few days ago, that fix this issue for maybe a single file. To me, that does not look like a better approach than fixing it once everywhere and be done with it.

@pfalcon
Copy link
Contributor

pfalcon commented Jun 30, 2017

Is that really necessary, from a legal point of view, especially if the file has not been touched in recent years?

So, all files which were updated, need copyright year updated.

@webmeister
Copy link
Contributor Author

Do you mean I should update the copyright year to include 2017 for all files that this commit touches? Or that there needs to be a commit that updates the copyright year for all files in the repository that have been touched after their specified copyright year, even if those files were not originally touched by this commit?

@pfalcon
Copy link
Contributor

pfalcon commented Jun 30, 2017

I, as "IMHO", would suggest that patch like this also included copyright year updates. The best next step is to wait for @dpgeorge's comments, specific details can be discussed later.

@tomlogic
Copy link
Contributor

Should there be a post-commit hook to notify when files were modified but the copyright wasn't updated?

@mcauser
Copy link
Contributor

mcauser commented Jul 3, 2017

According to US copyright law, you do not need to update the copyright each year on all the files.
The year is the year of first publication, not the current year.
http://www.contentious.com/2007/01/07/copyright-notice-is-the-year-really-necessary/

If the work is a derivative work or a compilation incorporating previously published material, the year date of first publication of the derivative work or compilation is sufficient.

@dpgeorge
Copy link
Member

dpgeorge commented Jul 3, 2017

Let's just do this and get it out of the way.

@webmeister please can you change only those instances of "Micro Python" that appear in comments (which I think is all instances of "Micro Python"). Anything in the docs should be a separate PR, and changes to the code should be separate (eg the change to cc3200 ftp server would be a breaking change from a users' point of view).

IMO copyright year should be changed by the author who's name appears in the copyright line, and only if/when they make non-trivial changes to the respective file. (Eg there are some files with multiple copyright lines, and it doesn't make sense to change them all to include the year 2017 because in a lot of those cases there is nothing new by that person to copyright.)

@pfalcon
Copy link
Contributor

pfalcon commented Jul 27, 2017

@webmeister : Are you going to proceed with this as recommended with @dpgeorge ? Otherwise, conflicts start to accumulate, etc.

@webmeister
Copy link
Contributor Author

Oh, sorry, I didn't notice that this was still open. Together with #3211 and #3212 I had uploaded a new version of this PR (e0415da), but I did not add another comment here, so it probably slipped through?

I can rebase the commit and check for new misspellings later.

There were several different spellings of MicroPython present in comments,
when there should be only one.
@dpgeorge
Copy link
Member

Thanks @webmeister for updating. This was merged in 55f3324

@dpgeorge dpgeorge closed this Jul 31, 2017
@webmeister webmeister deleted the micropython-consistency branch July 31, 2017 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants