Add default license notice to all Rust files #3317

alevy · 2022-11-04T16:52:51Z

Pull Request Overview

This pull request adds a default copyright and license notice to all Rust files in the repository

Testing Strategy

None

TODO or Help Wanted

Documentation Updated

[] Updated the relevant files in /docs, or no updates are required.

Formatting

Ran make prepush.

hudson-ayers · 2022-11-04T17:14:31Z

2 files we may need to consider:

hudson: ~/tock (master) $ rg Copyright --type rust
capsules/src/sip_hash.rs
16://! Copyright 2012-2016 The Rust Project Developers.
17://! Copyright 2016-2021 Frank Denis.
18://! Copyright 2021 Western Digital

chips/nrf52/src/crt1.rs
11: * Copyright 2016, Michael Andersen <[email protected]>

Based on the discussion on the call today, I think our conclusion was that these files should have the added copyright in this PR removed in favor of what is already there. It is also worth noting that the crt1 file seems to be licensed only under Apache 2.0

alevy · 2022-11-04T18:07:04Z

@hudson-ayers thanks for finding those! Fixed those two files (by just removing the lines I had added)

jrvanwhy · 2022-11-04T18:21:46Z

I thought Pat was going to write up a policy document for license headers. Did I misunderstand during the meeting?

hudson-ayers · 2022-11-04T18:52:40Z

I thought Pat was going to write up a policy document for license headers. Did I misunderstand during the meeting?

You understood correctly, I don't think this will be merged without that document first getting written and approved.

arch/cortex-m/src/lib.rs

bradjc · 2022-11-21T18:45:59Z

Why is the first line Apache or MIT, and the second line MIT or Apache?

alevy · 2022-11-22T01:44:33Z

Why is the first line Apache or MIT, and the second line MIT or Apache?

Oops... because I made a mistake. Will fix

alevy · 2023-01-20T13:23:29Z

Rebased and added the Copyright Tock Contributors 2023 line

alevy · 2023-03-30T18:28:09Z

@jrvanwhy done

jrvanwhy

Also, the following files were added in #3396, same question (2022 or 2023):

chips/stm32f4xx/src/can.rs

kernel/src/hil/can.rs

tools/sha256sum/src/main.rs

boards/components/src/can.rs

jrvanwhy · 2023-03-31T01:01:33Z

capsules/extra/src/can.rs

+// Licensed under the Apache License, Version 2.0 or the MIT License.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+// Copyright Tock Contributors 2022.
+


This file already has a license header, please revert.

jrvanwhy · 2023-03-31T01:37:31Z

Oh, and please don't bulk-update this PR to say 2023 instead of 2022 -- I've marked every file as viewed and I'd strongly prefer to not lose that state.

jrvanwhy · 2023-03-31T17:11:41Z

@lschuermann The following files were added in #3110, should they be copyright 2022 or 2023?

chips/qemu_rv32_virt_chip/src/virtio_mmio.rs

chips/virtio/src/queues/split_queue.rs

Also, the following files were added in #3396, same question (2022 or 2023):

capsules/core/Cargo.toml

capsules/core/src/lib.rs

capsules/core/src/virtualizers/mod.rs

capsules/extra/Cargo.toml

capsules/extra/src/test/mod.rs

Leon wasn't immediately available, so we decided on the core WG call to change these dates to 2023 so this can be merged ASAP.

jrvanwhy · 2023-03-31T17:12:36Z

You'll need to add tools/sha256sum/src/main.rs to a .lcignore file for CI to pass.

capsules/core/src/virtualizers/mod.rs

lschuermann · 2023-03-31T20:05:23Z

Leon wasn't immediately available, so we decided on the core WG call to change these dates to 2023 so this can be merged ASAP.

@jrvanwhy My apologies for the delayed response! 2023 is absolutely fine, I can update them right now.

lschuermann · 2023-03-31T20:11:13Z

Okay, raced with @alevy on the push. This looks good to me otherwise, thanks so much for the work!

jrvanwhy

capsules/extra/src/can.rs still has an extra header, but we can fix that in a later PR.

alevy · 2023-04-01T01:41:19Z

bors r+

bors · 2023-04-01T01:41:23Z

👎 Rejected by label

alevy · 2023-04-01T01:44:25Z

bors r+

bors · 2023-04-01T02:12:36Z

Build succeeded:

This PR adds license headers for every file type in the repository that the license checker supports. This uses the same license notice style as tock#3317, setting the copyright year to the current year (2023) across-the-board. I removed the `/.envrc` and `/.direnv` exclusions, as I don't think they belong it `.lcignore`. I think they belong in `.gitignore` instead? I'd appreciate input on where they belong (or why I was wrong and they belong in `.lcignore`). I also made a stylistic decision to have a single `.lcignore` file in the root of the repository. To that end, I kept `doc/`-specific rules in the root `.lcignore`, and removed `tools/license-checker/testdata/.lcignore`.

3420: Add license headers to every file the license checker supports. r=jrvanwhy a=jrvanwhy This PR adds license headers for every file type in the repository that the license checker supports. This uses the same license notice style as #3317, setting the copyright year to the current year (2023) across-the-board. I removed the `/.envrc` and `/.direnv` exclusions, as I don't think they belong it `.lcignore`. I think they belong in `.gitignore` instead? I'd appreciate input on where they belong (or why I was wrong and they belong in `.lcignore`). I also made a stylistic decision to have a single `.lcignore` file in the root of the repository. To that end, I kept `doc/`-specific rules in the root `.lcignore`, and removed `tools/license-checker/testdata/.lcignore`. Oh, and I removed the duplicate header on `capsules/extra/src/can.rs`. 3424: doc: notes: update dates and format r=brghena a=bradjc ### Pull Request Overview Just a couple of minor fixes to documentation dates and formatting I found. ### Testing Strategy This pull request was tested by... ### TODO or Help Wanted This pull request still needs... ### Documentation Updated - [x] Updated the relevant files in `/docs`, or no updates are required. ### Formatting - [x] Ran `make prepush`. Co-authored-by: Johnathan Van Why <[email protected]> Co-authored-by: Brad Campbell <[email protected]>

alevy added the P-Significant This is a substancial change that requires review from all core developers. label Nov 4, 2022

alevy requested review from bradjc, brghena, hudson-ayers, jrvanwhy, phil-levis and ppannuto November 4, 2022 17:04

alevy force-pushed the license branch from aa549c4 to 055095c Compare November 4, 2022 18:06

lschuermann added the blocked Waiting on something, like a different PR or a dependency. label Nov 4, 2022

brghena reviewed Nov 4, 2022

View reviewed changes

arch/cortex-m/src/lib.rs Outdated Show resolved Hide resolved

hudson-ayers mentioned this pull request Nov 5, 2022

trd: license and copyright policy #3318

Merged

2 tasks

alevy force-pushed the license branch from 055095c to aba6e5a Compare November 9, 2022 19:36

alevy force-pushed the license branch from ffba1a8 to a319b3e Compare November 22, 2022 01:50

alevy force-pushed the license branch from 1405344 to 187734c Compare January 20, 2023 13:22

alevy force-pushed the license branch from ef5804d to ee3973f Compare March 30, 2023 17:45

hudson-ayers previously approved these changes Mar 30, 2023

View reviewed changes

jrvanwhy reviewed Mar 31, 2023

View reviewed changes

bradjc previously approved these changes Mar 31, 2023

View reviewed changes

alevy added 3 commits March 31, 2023 13:03

revert changes to tools/sha256sum/src/main.rs

ee21a56

Remove duplicate license notices

10f1699

Update copyright year

2f49fcf

alevy dismissed stale reviews from bradjc and hudson-ayers via 2f49fcf March 31, 2023 17:04

jrvanwhy reviewed Mar 31, 2023

View reviewed changes

capsules/core/src/virtualizers/mod.rs Outdated Show resolved Hide resolved

Final license fixes (I hope)

76498b9

lschuermann approved these changes Mar 31, 2023

View reviewed changes

jrvanwhy approved these changes Mar 31, 2023

View reviewed changes

alevy removed the blocked Waiting on something, like a different PR or a dependency. label Apr 1, 2023

bors bot merged commit 9496135 into master Apr 1, 2023

bors bot deleted the license branch April 1, 2023 02:12

jrvanwhy mentioned this pull request Apr 1, 2023

Add license headers to every file the license checker supports. #3420

Merged

jrvanwhy mentioned this pull request Jun 7, 2023

Add license headers to .ld files. #3472

Merged

Uh oh!

Add default license notice to all Rust files #3317

Add default license notice to all Rust files #3317

Uh oh!

Conversation

alevy commented Nov 4, 2022

Pull Request Overview

Testing Strategy

TODO or Help Wanted

Documentation Updated

Formatting

Uh oh!

hudson-ayers commented Nov 4, 2022

Uh oh!

alevy commented Nov 4, 2022

Uh oh!

jrvanwhy commented Nov 4, 2022

Uh oh!

hudson-ayers commented Nov 4, 2022

Uh oh!

Uh oh!

bradjc commented Nov 21, 2022

Uh oh!

alevy commented Nov 22, 2022

Uh oh!

alevy commented Jan 20, 2023

Uh oh!

alevy commented Mar 30, 2023

Uh oh!

jrvanwhy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jrvanwhy Mar 31, 2023

Choose a reason for hiding this comment

Uh oh!

jrvanwhy commented Mar 31, 2023

Uh oh!

jrvanwhy commented Mar 31, 2023

Uh oh!

jrvanwhy commented Mar 31, 2023

Uh oh!

Uh oh!

lschuermann commented Mar 31, 2023

Uh oh!

lschuermann commented Mar 31, 2023

Uh oh!

jrvanwhy left a comment

Choose a reason for hiding this comment

Uh oh!

alevy commented Apr 1, 2023

Uh oh!

bors bot commented Apr 1, 2023

Uh oh!

alevy commented Apr 1, 2023

Uh oh!

bors bot commented Apr 1, 2023

Uh oh!

Uh oh!