Source code cleanup: add standardized headers to modules where copyright information is missing

[josephsl]

Hi,

Part of #6589 work:

Although most NVDA modules do have standardized headers, it would be ideal to let all of them have copyrights, author information and others (not just Python files, but also C++ source). The biggest underlying problem is that we lost track of who wrote what module and when it was first created and last modified (one can consult Git log for most of this information, but it's quite tedious).

Thus the following procedure is proposed:

1. List files with missing header information.
2. For each file, use Git log to locate list of authors or contributors, creation date and date of last modification (used for knowing copyright years).
3. Add standardized headers as comments (for C++, multi-line comments would do).

Thanks.

[feerrenrut]

Retroactively updating the file headers is fairly low priority in the scheme of things. I think this is something we could pay more attention to during code review. I'm going to set this as a priority 4 since it's unlikely that we will do this internally. However we will accept a PR for the changes.

If someone is to take this on, on the PR please outline the process taken / provide any source code or implementation details for how this is automated. This is important so that we can more easily check the output for correctness. Manually checking the change set would be quite time consuming.

[josephsl]

Hi,

2024 update: while it might be possible to add copyright headers to files missing these, I agree with Reef that it could be done while editing files with missing headers (we could have done that while converting from Flake8 to Ruff, but that's out of scope).

Thanks.

[Adriani90]

@josephsl my understanding is that now there is an automatic check for license header in the appveyor when building, is this issue solved?

[hwf1324]

@josephsl my understanding is that now there is an automatic check for license header in the appveyor when building, is this issue solved?

No, I remember checking for licence compatibility now.

[josephsl]

Hi, nope. Thanks.

From: Adriani90 @.> Sent: Saturday, October 5, 2024 5:11 AM To: nvaccess/nvda @.> Cc: Joseph Lee @.>; Mention @.> Subject: Re: [nvaccess/nvda] Source code cleanup: add standardized headers to modules where copyright information is missing (#6591)

@josephsl https://github.com/josephsl my understanding is that now there is an automatic check for license header in the appveyor when building, is this issue solved?

— Reply to this email directly, view it on GitHub https://github.com/nvaccess/nvda/issues/6591#issuecomment-2395021590 , or unsubscribe https://github.com/notifications/unsubscribe-auth/AB4AXEGMGOYTKCSQOUP2PS3ZZ7CLPAVCNFSM6AAAAABK3XWCBSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGOJVGAZDCNJZGA . You are receiving this because you were mentioned.Message ID: @.***>