Skip to content

Commit 6599946

Browse files
borsbors
committed
Auto merge of #57520 - alexreg:tidy-copyright-lint, r=Mark-Simulacrum
Add lint for copyright headers to 'tidy' tool r? @Mark-Simulacrum CC @Centril
2 parents 722b4d6 + 4d18023 commit 6599946

31 files changed

+165
-207
lines changed

‎src/doc/book

Submodule book updated 176 files

‎src/doc/reference

‎src/libcore/slice/memchr.rs

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
//
2-
// Original implementation taken from rust-memchr
1+
// Original implementation taken from rust-memchr.
32
// Copyright 2015 Andrew Gallant, bluss and Nicolas Koch
43

54
use cmp;
@@ -8,13 +7,13 @@ use mem;
87
const LO_U64: u64 = 0x0101010101010101;
98
const HI_U64: u64 = 0x8080808080808080;
109

11-
// use truncation
10+
// Use truncation.
1211
const LO_USIZE: usize = LO_U64 as usize;
1312
const HI_USIZE: usize = HI_U64 as usize;
1413

15-
/// Return `true` if `x` contains any zero byte.
14+
/// Returns whether `x` contains any zero byte.
1615
///
17-
/// From *Matters Computational*, J. Arndt
16+
/// From *Matters Computational*, J. Arndt:
1817
///
1918
/// "The idea is to subtract one from each of the bytes and then look for
2019
/// bytes where the borrow propagated all the way to the most significant
@@ -36,7 +35,7 @@ fn repeat_byte(b: u8) -> usize {
3635
(b as usize) * (::usize::MAX / 255)
3736
}
3837

39-
/// Return the first index matching the byte `x` in `text`.
38+
/// Returns the first index matching the byte `x` in `text`.
4039
pub fn memchr(x: u8, text: &[u8]) -> Option<usize> {
4140
// Scan for a single byte value by reading two `usize` words at a time.
4241
//
@@ -77,18 +76,18 @@ pub fn memchr(x: u8, text: &[u8]) -> Option<usize> {
7776
}
7877
}
7978

80-
// find the byte after the point the body loop stopped
79+
// Find the byte after the point the body loop stopped.
8180
text[offset..].iter().position(|elt| *elt == x).map(|i| offset + i)
8281
}
8382

84-
/// Return the last index matching the byte `x` in `text`.
83+
/// Returns the last index matching the byte `x` in `text`.
8584
pub fn memrchr(x: u8, text: &[u8]) -> Option<usize> {
8685
// Scan for a single byte value by reading two `usize` words at a time.
8786
//
88-
// Split `text` in three parts
89-
// - unaligned tail, after the last word aligned address in text
90-
// - body, scan by 2 words at a time
91-
// - the first remaining bytes, < 2 word size
87+
// Split `text` in three parts:
88+
// - unaligned tail, after the last word aligned address in text,
89+
// - body, scanned by 2 words at a time,
90+
// - the first remaining bytes, < 2 word size.
9291
let len = text.len();
9392
let ptr = text.as_ptr();
9493
type Chunk = usize;
@@ -105,7 +104,7 @@ pub fn memrchr(x: u8, text: &[u8]) -> Option<usize> {
105104
return Some(offset + index);
106105
}
107106

108-
// search the body of the text, make sure we don't cross min_aligned_offset.
107+
// Search the body of the text, make sure we don't cross min_aligned_offset.
109108
// offset is always aligned, so just testing `>` is sufficient and avoids possible
110109
// overflow.
111110
let repeated_x = repeat_byte(x);
@@ -116,7 +115,7 @@ pub fn memrchr(x: u8, text: &[u8]) -> Option<usize> {
116115
let u = *(ptr.offset(offset as isize - 2 * chunk_bytes as isize) as *const Chunk);
117116
let v = *(ptr.offset(offset as isize - chunk_bytes as isize) as *const Chunk);
118117

119-
// break if there is a matching byte
118+
// Break if there is a matching byte.
120119
let zu = contains_zero_byte(u ^ repeated_x);
121120
let zv = contains_zero_byte(v ^ repeated_x);
122121
if zu || zv {
@@ -126,6 +125,6 @@ pub fn memrchr(x: u8, text: &[u8]) -> Option<usize> {
126125
offset -= 2 * chunk_bytes;
127126
}
128127

129-
// find the byte before the point the body loop stopped
128+
// Find the byte before the point the body loop stopped.
130129
text[..offset].iter().rposition(|elt| *elt == x)
131130
}

‎src/libserialize/json.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Rust JSON serialization library
1+
// Rust JSON serialization library.
22
// Copyright (c) 2011 Google Inc.
33

44
#![forbid(non_camel_case_types)]

‎src/libstd/memchr.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
//
2-
// Original implementation taken from rust-memchr
1+
// Original implementation taken from rust-memchr.
32
// Copyright 2015 Andrew Gallant, bluss and Nicolas Koch
43

54
/// A safe interface to `memchr`.

‎src/libstd/sys/cloudabi/abi/cloudabi.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (c) 2016-2017 Nuxi (https://nuxi.nl/) and contributors.
1+
// Copyright (c) 2016-2017 Nuxi <https://nuxi.nl/> and contributors.
22
//
33
// Redistribution and use in source and binary forms, with or without
44
// modification, are permitted provided that the following conditions

‎src/libstd/sys/redox/memchr.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
//
2-
// Original implementation taken from rust-memchr
1+
// Original implementation taken from rust-memchr.
32
// Copyright 2015 Andrew Gallant, bluss and Nicolas Koch
43

54
pub use core::slice::memchr::{memchr, memrchr};

‎src/libstd/sys/unix/memchr.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
//
2-
// Original implementation taken from rust-memchr
1+
// Original implementation taken from rust-memchr.
32
// Copyright 2015 Andrew Gallant, bluss and Nicolas Koch
43

54
pub fn memchr(needle: u8, haystack: &[u8]) -> Option<usize> {

‎src/libstd/sys/windows/memchr.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
//
2-
// Original implementation taken from rust-memchr
1+
// Original implementation taken from rust-memchr.
32
// Copyright 2015 Andrew Gallant, bluss and Nicolas Koch
43

5-
// Fallback memchr is fastest on windows
4+
// Fallback memchr is fastest on Windows.
65
pub use core::slice::memchr::{memchr, memrchr};

‎src/libsyntax/json.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
//! The format of the JSON output should be considered *unstable*. For now the
88
//! structs at the end of this file (Diagnostic*) specify the error format.
99
10-
// FIXME spec the JSON output properly.
10+
// FIXME: spec the JSON output properly.
1111

1212
use source_map::{SourceMap, FilePathMapping};
1313
use syntax_pos::{self, MacroBacktrace, Span, SpanLabel, MultiSpan};

‎src/test/compile-fail-fulldeps/auxiliary/lint_group_plugin_test.rs

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,3 @@
1-
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
2-
// file at the top-level directory of this distribution and at
3-
// http://rust-lang.org/COPYRIGHT.
4-
//
5-
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6-
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7-
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8-
// option. This file may not be copied, modified, or distributed
9-
// except according to those terms.
10-
111
// force-host
122

133
#![feature(plugin_registrar)]

‎src/test/rustdoc-ui/deny-missing-docs-crate.rs

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,3 @@
1-
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
2-
// file at the top-level directory of this distribution and at
3-
// http://rust-lang.org/COPYRIGHT.
4-
//
5-
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6-
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7-
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8-
// option. This file may not be copied, modified, or distributed
9-
// except according to those terms.
10-
111
#![deny(missing_docs)] //~ ERROR
122

133
pub struct Foo; //~ ERROR

‎src/test/rustdoc-ui/deny-missing-docs-crate.stderr

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
error: missing documentation for crate
2-
--> $DIR/deny-missing-docs-crate.rs:11:1
2+
--> $DIR/deny-missing-docs-crate.rs:1:1
33
|
44
LL | / #![deny(missing_docs)] //~ ERROR
55
LL | |
66
LL | | pub struct Foo; //~ ERROR
77
| |_______________^
88
|
99
note: lint level defined here
10-
--> $DIR/deny-missing-docs-crate.rs:11:9
10+
--> $DIR/deny-missing-docs-crate.rs:1:9
1111
|
1212
LL | #![deny(missing_docs)] //~ ERROR
1313
| ^^^^^^^^^^^^
1414

1515
error: missing documentation for a struct
16-
--> $DIR/deny-missing-docs-crate.rs:13:1
16+
--> $DIR/deny-missing-docs-crate.rs:3:1
1717
|
1818
LL | pub struct Foo; //~ ERROR
1919
| ^^^^^^^^^^^^^^^

‎src/test/rustdoc-ui/deny-missing-docs-macro.rs

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,3 @@
1-
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
2-
// file at the top-level directory of this distribution and at
3-
// http://rust-lang.org/COPYRIGHT.
4-
//
5-
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6-
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7-
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8-
// option. This file may not be copied, modified, or distributed
9-
// except according to those terms.
10-
111
//! foo
122
133
#![deny(missing_docs)]

‎src/test/rustdoc-ui/deny-missing-docs-macro.stderr

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
error: missing documentation for macro
2-
--> $DIR/deny-missing-docs-macro.rs:16:1
2+
--> $DIR/deny-missing-docs-macro.rs:6:1
33
|
44
LL | macro_rules! foo { //~ ERROR
55
| ^^^^^^^^^^^^^^^^
66
|
77
note: lint level defined here
8-
--> $DIR/deny-missing-docs-macro.rs:13:9
8+
--> $DIR/deny-missing-docs-macro.rs:3:9
99
|
1010
LL | #![deny(missing_docs)]
1111
| ^^^^^^^^^^^^

‎src/test/rustdoc/auxiliary/enum_primitive.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
2020
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2121

22-
2322
//! This crate exports a macro `enum_from_primitive!` that wraps an
2423
//! `enum` declaration and automatically adds an implementation of
2524
//! `num::FromPrimitive` (reexported here), to allow conversion from
@@ -52,7 +51,6 @@
5251
//! }
5352
//! ```
5453
55-
5654
pub mod num_traits {
5755
pub trait FromPrimitive: Sized {
5856
fn from_i64(n: i64) -> Option<Self>;
@@ -207,4 +205,3 @@ macro_rules! enum_from_primitive {
207205
enum_from_primitive_impl! { $name, $( $( $variant )+ )+ }
208206
};
209207
}
210-

‎src/test/rustdoc/no-crate-filter.rs

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,3 @@
1-
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
2-
// file at the top-level directory of this distribution and at
3-
// http://rust-lang.org/COPYRIGHT.
4-
//
5-
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6-
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7-
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8-
// option. This file may not be copied, modified, or distributed
9-
// except according to those terms.
10-
111
#![crate_name = "foo"]
122

133
// compile-flags: -Z unstable-options --disable-per-crate-search

‎src/test/ui/feature-gates/feature-gate-type_alias_enum_variants.rs

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,3 @@
1-
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
2-
// file at the top-level directory of this distribution and at
3-
// http://rust-lang.org/COPYRIGHT.
4-
//
5-
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6-
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7-
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8-
// option. This file may not be copied, modified, or distributed
9-
// except according to those terms.
10-
111
enum Foo {
122
Bar(i32),
133
Baz { i: i32 },

‎src/test/ui/feature-gates/feature-gate-type_alias_enum_variants.stderr

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
error: enum variants on type aliases are experimental
2-
--> $DIR/feature-gate-type_alias_enum_variants.rs:19:13
2+
--> $DIR/feature-gate-type_alias_enum_variants.rs:9:13
33
|
44
LL | let t = Alias::Bar(0);
55
| ^^^^^^^^^^
66
|
77
= help: add `#![feature(type_alias_enum_variants)]` to the crate attributes to enable
88

99
error: enum variants on type aliases are experimental
10-
--> $DIR/feature-gate-type_alias_enum_variants.rs:21:13
10+
--> $DIR/feature-gate-type_alias_enum_variants.rs:11:13
1111
|
1212
LL | let t = Alias::Baz { i: 0 };
1313
| ^^^^^^^^^^
1414
|
1515
= help: add `#![feature(type_alias_enum_variants)]` to the crate attributes to enable
1616

1717
error: enum variants on type aliases are experimental
18-
--> $DIR/feature-gate-type_alias_enum_variants.rs:24:9
18+
--> $DIR/feature-gate-type_alias_enum_variants.rs:14:9
1919
|
2020
LL | Alias::Bar(_i) => {}
2121
| ^^^^^^^^^^^^^^
2222
|
2323
= help: add `#![feature(type_alias_enum_variants)]` to the crate attributes to enable
2424

2525
error: enum variants on type aliases are experimental
26-
--> $DIR/feature-gate-type_alias_enum_variants.rs:26:9
26+
--> $DIR/feature-gate-type_alias_enum_variants.rs:16:9
2727
|
2828
LL | Alias::Baz { i: _i } => {}
2929
| ^^^^^^^^^^

‎src/tools/tidy/src/bins.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
//! by accident.
33
//!
44
//! In the past we've accidentally checked in test binaries and such which add a
5-
//! huge amount of bloat to the git history, so it's good to just ensure we
6-
//! don't do that again :)
5+
//! huge amount of bloat to the Git history, so it's good to just ensure we
6+
//! don't do that again.
77
88
use std::path::Path;
99

10-
// All files are executable on Windows, so just check on Unix
10+
// All files are executable on Windows, so just check on Unix.
1111
#[cfg(windows)]
1212
pub fn check(_path: &Path, _bad: &mut bool) {}
1313

‎src/tools/tidy/src/cargo.rs

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pub fn check(path: &Path, bad: &mut bool) {
1313
return
1414
}
1515
for entry in t!(path.read_dir(), path).map(|e| t!(e)) {
16-
// Look for `Cargo.toml` with a sibling `src/lib.rs` or `lib.rs`
16+
// Look for `Cargo.toml` with a sibling `src/lib.rs` or `lib.rs`.
1717
if entry.file_name().to_str() == Some("Cargo.toml") {
1818
if path.join("src/lib.rs").is_file() {
1919
verify(&entry.path(), &path.join("src/lib.rs"), bad)
@@ -27,8 +27,8 @@ pub fn check(path: &Path, bad: &mut bool) {
2727
}
2828
}
2929

30-
// Verify that the dependencies in Cargo.toml at `tomlfile` are sync'd with the
31-
// `extern crate` annotations in the lib.rs at `libfile`.
30+
/// Verifies that the dependencies in Cargo.toml at `tomlfile` are synced with
31+
/// the `extern crate` annotations in the lib.rs at `libfile`.
3232
fn verify(tomlfile: &Path, libfile: &Path, bad: &mut bool) {
3333
let toml = t!(fs::read_to_string(&tomlfile));
3434
let librs = t!(fs::read_to_string(&libfile));
@@ -37,14 +37,16 @@ fn verify(tomlfile: &Path, libfile: &Path, bad: &mut bool) {
3737
return
3838
}
3939

40-
// "Poor man's TOML parser", just assume we use one syntax for now
40+
// "Poor man's TOML parser" -- just assume we use one syntax for now.
4141
//
4242
// We just look for:
4343
//
44-
// [dependencies]
45-
// name = ...
46-
// name2 = ...
47-
// name3 = ...
44+
// ````
45+
// [dependencies]
46+
// name = ...
47+
// name2 = ...
48+
// name3 = ...
49+
// ```
4850
//
4951
// If we encounter a line starting with `[` then we assume it's the end of
5052
// the dependency section and bail out.
@@ -63,14 +65,14 @@ fn verify(tomlfile: &Path, libfile: &Path, bad: &mut bool) {
6365
continue
6466
}
6567

66-
// Don't worry about depending on core/std but not saying `extern crate
67-
// core/std`, that's intentional.
68+
// Don't worry about depending on core/std while not writing `extern crate
69+
// core/std` -- that's intentional.
6870
if krate == "core" || krate == "std" {
6971
continue
7072
}
7173

72-
// This is intentional, this dependency just makes the crate available
73-
// for others later on. Cover cases
74+
// This is intentional -- this dependency just makes the crate available
75+
// for others later on.
7476
let whitelisted = krate.starts_with("panic");
7577
if toml.contains("name = \"std\"") && whitelisted {
7678
continue

0 commit comments

Comments
 (0)