Commit graph

150 commits

Author SHA1 Message Date
Camelid
bd71b01a82 Make the docs clearer for new contributors
* Add an easy-to-see note at the top of `CONTRIBUTING.md` that points
  new contributors to the Basics docs
* Add a note about compiler errors as a result of internals changes
  that break Clippy
2020-08-07 16:15:44 -07:00
flip1995
51f2a6f8b6
Add documentation for basic Clippy hacking 2020-07-22 16:46:32 +02:00
flip1995
6f25adbd5a Merge commit '2ca58e7dda4a9eb142599638c59dc04d15961175' into clippyup 2020-07-14 14:59:59 +02:00
Takayuki Nakata
c79c6888a5 Fix a broken link in CONTRIBUTING.md 2020-07-09 22:07:15 +09:00
Lzu Tao
8db24840f7 Merge commit 'ff0993c5e9162ddaea78e83d0f0161e68bd4ea73' into clippy 2020-06-09 14:36:01 +00:00
Matthias Krüger
7727c4ac7f CONTRIBUTING: explain how to use cargo dev ra-setup
Fixes #5514
2020-05-31 23:20:23 +02:00
flip1995
a0e9f9bd0d Merge commit '7ea7cd165ad6705603852771bf82cc2fd6560db5' into clippyup2 2020-05-28 15:45:24 +02:00
Philipp Krones
7a83eafd44
Also fetch origin before merging master into the rustup branch 2020-05-25 17:11:07 +02:00
flip1995
1a9ba3b2c2
Add note, that a merge commit after push is necessary 2020-05-19 16:36:14 +02:00
flip1995
842dd07261
Add note that a subtree fix and stack limit increase is required 2020-05-19 15:18:16 +02:00
Philipp Krones
e5b5f6f8a9
Better explain remotes in the sync process. 2020-05-17 01:38:01 +02:00
Philipp Krones
c1698fedeb
Apply suggestions from code review
Co-authored-by: Phil Hansch <dev@phansch.net>
2020-05-03 16:47:57 +02:00
flip1995
17d877cce2
Update contributing section about syncing Clippy 2020-05-03 16:11:27 +02:00
Philipp Krones
b42bd1954a
Rollup merge of #5422 - nickrtorres:contributing-triage, r=flip1995
CONTRIBUTING.md: fix broken triage link

Fixes #5421
2020-04-08 15:50:25 +02:00
Nick Torres
fecdb72b14 CONTRIBUTING.md: fix broken triage link 2020-04-04 14:39:24 -07:00
flip1995
fac5a41ca5
Update CONTRIBUTING.md 2020-04-04 17:03:07 +02:00
flip1995
2481d3c74a
Rename rustc -> rustc_middle in doc links 2020-04-04 17:01:42 +02:00
Yuki Okushi
d4eb496856
Improve documentation 2020-03-11 06:35:46 +09:00
Yuki Okushi
19e72a24ae
Move links to the end of each chapter on CONTRIBUTING 2020-03-11 05:41:11 +09:00
Yuki Okushi
8cdd75ca29
Clean-up CONTRIBUTING.md 2020-03-11 05:21:40 +09:00
Vivek Ghaisas
3b3e5ea2a2 Mention the setup instructions in CONTRIBUTING
Multiple people seem to have missed this based on questions asked in the
Discord channel. Might as well mention it up front.
2020-03-08 21:07:18 +00:00
flip1995
757bbf7feb
Fix markdown Files
Rendered:

[CHANGELOG.md](https://github.com/flip1995/rust-clippy/blob/gha/CHANGELOG.md)
[CODE_OF_CONDUCT.md](https://github.com/flip1995/rust-clippy/blob/gha/CODE_OF_CONDUCT.md)
[CONTRIBUTING.md](https://github.com/flip1995/rust-clippy/blob/gha/CONTRIBUTING.md)
[README.md](https://github.com/flip1995/rust-clippy/blob/gha/README.md)
[clippy_dummy/PUBLISH.md](https://github.com/flip1995/rust-clippy/blob/gha/clippy_dummy/PUBLISH.md)
[doc/adding_lints.md](https://github.com/flip1995/rust-clippy/blob/gha/doc/adding_lints.md)
[etc/relicense/RELICENSE_DOCUMENTATION.md](https://github.com/flip1995/rust-clippy/blob/gha/etc/relicense/RELICENSE_DOCUMENTATION.md)
2020-02-12 09:34:25 +01:00
Krishna Sai Veera Reddy
1e117938cf Remove unnecessary imports from documentation 2020-02-10 19:37:25 -08:00
Philipp Hansch
4d1a11d354
Deprecate util/dev in favor of cargo alias
If you've been using `./util/dev` before, this now becomes `cargo dev`.

The key part of this change is found in `.cargo/config`.

This means one less shell script and a bit more cross-platform support
for contributors.
2020-01-30 21:34:31 +01:00
flip1995
8d38a07fb6
Revert "rustc-dev has been temporarily removed"
This reverts commit 974a05b806.
2019-10-24 14:03:24 +02:00
Lzu Tao
974a05b806 rustc-dev has been temporarily removed 2019-10-14 10:25:05 +07:00
Lzu Tao
dce46325b5 Rustup for rustc-dev 2019-10-11 15:53:55 +07:00
Yuki Okushi
2c58936a27 Add note to fix toolstate 2019-08-29 01:07:46 +09:00
Simon Sapin
08d8ffc6a9 Import rustc_plugin from its new location
Depends on https://github.com/rust-lang/rust/pull/62727
2019-08-19 17:52:10 +02:00
chansuke
4a70ad43e1 Fix the name of a channel of discord in CONTRIBUTING.md 2019-08-19 18:31:25 +09:00
Philipp Hansch
1eac53b06b
Cleanup 'Writing code' in CONTRIBUTING.md
This is now all included in `doc/adding_lints.md`
2019-03-03 15:03:25 +01:00
Philipp Hansch
f934f98111
Add a uitest subcommand to simplify UI test invocation
This allows to run

`TESTNAME=xxx cargo uitest`

instead of

`TESTNAME=xxx cargo test --test-compile-test`
2019-02-08 08:09:37 +01:00
Jeremy Fitzhardinge
47563a13eb Add setup-toolchain.sh script to configure the master version of rustc,
and update CONTRIBUTING.md accordingly.
2019-02-03 14:41:46 -08:00
rmcteggart-r7
d17c3d99d0 Fixing typo in CONTRIBUTING.md 2019-01-20 21:25:36 +00:00
Philipp Hansch
3f978afe8d
Update CONTRIBUTING.md for rustfix tests 2018-12-28 20:53:44 +01:00
flip1995
b5e545afc2
Mention S-inactive-closed PRs in the CONTRIBUTING.md 2018-12-27 17:34:17 +01:00
Philipp Hansch
ff634e2350
Change contrib.md hierarchy, link to it from readme
'How Clippy works' and 'How to fix nightly failures' are not exactly part
of 'Writing code'.
2018-12-21 08:11:06 +01:00
Maxence Frenette
804729cdaa Remove dead link in CONTRIBUTING.md 2018-12-11 05:10:41 -05:00
Philipp Hansch
740634a154
Document bors/homu 2018-12-10 08:06:07 +01:00
Philipp Hansch
2213904024
Small updates to CONTRIBUTING.md 2018-12-10 08:06:07 +01:00
Wayne Warren
1db535a887 Remove unnecessary documentation 2018-12-05 18:18:17 -06:00
Philipp Hansch
b06594e650
Merge pull request #3483 from phansch/mention_triage_procedure_in_contributing
Mention triage procedure in contributing.md
2018-12-02 12:35:14 +01:00
Philipp Hansch
451085ca8d
Fix some nursery links 2018-12-02 11:45:05 +01:00
Philipp Hansch
40d58f9195
Mention triage procedure in contributing.md 2018-12-02 09:35:47 +01:00
Oliver S̶c̶h̶n̶e̶i̶d̶e̶r Scherer
f5831523d3
Merge pull request #3465 from flip1995/rustfmt
rustfmt everything once and for all
2018-11-28 16:19:55 +01:00
Philipp Krones
33c1e3c08c
Add missing word
Co-Authored-By: phansch <dev@phansch.net>
2018-11-28 14:39:25 +01:00
Philipp Hansch
93e8c9efc9
Update docs in regards to the merged RFC 2018-11-28 08:11:28 +01:00
flip1995
14d1e8d174
Document how to run rustfmt in CONTRIBUTING.md 2018-11-27 22:38:15 +01:00
Matthias Krüger
f5929e0797 rust-lang-nursery/rust-clippy => rust-lang/rust-clippy 2018-11-22 04:40:09 +01:00
Wayne Warren
4450b3e47a Fix awkward wording 2018-11-21 07:16:03 -06:00
Wayne Warren
30b3bc8d80 Document how to lint local Clippy changes with locally built Clippy 2018-11-21 07:12:00 -06:00
Philipp Hansch
90f31e21ab
RIIR update lints: Add check mode (update_lints.py rewrite complete)
This finishes up the rewrite of `update_lints.py` in Rust. More
specifically, this

* adds the `--check` flag and handling to clippy_dev
* tracks file changes over the different calls to `replace_region_in_file`
* only writes changes to files if the `--check` flag is *not* used
* runs `./util/dev update_lints --check` on CI instead of the old script
* replaces usage of the `update_lints.py` script with an error

`./util/dev update_lints` behaves 99% the same as the python script.
The only difference that I'm aware of is an ordering change to
`clippy_lints/src/lib.rs` because underscores seem to be sorted
differently in Rust and in Python.

🏁
2018-11-05 07:18:47 +01:00
Daniele D'Orazio
e1d7f00e43 fix command to manually test an example 2018-10-07 11:56:13 +02:00
Philipp Hansch
f72cfc2985
Mention rustup component history 2018-09-20 07:10:23 +02:00
Philipp Hansch
2b57cec649
s/rustc/Rust/ 2018-09-20 06:58:07 +02:00
Philipp Hansch
f9511bfdc3
s/rust/Rust, repeat 'Clippy' less 2018-09-20 06:56:51 +02:00
Philipp Hansch
9c50aa8810
Mention how to install master Rust in CONTRIBUTING 2018-09-19 21:15:08 +02:00
flip1995
83baf8f5fe Adapt documentation to the tool_lints 2018-08-29 11:08:29 -07:00
Oliver Schneider
d99cea0f16 Update imports and rustup 2018-08-28 13:13:42 +02:00
Matthias Krüger
be8863836e CONTRIBUTING: mention discord channel. 2018-07-30 00:10:19 +02:00
csmoe
1bd17e4fa2 ExprKind 2018-07-16 11:46:37 +02:00
Dale Wijnand
d95d6516b4
Consistently call it "Clippy", not clippy or rust-clippy
As per discussion on the Clippy 1.0 RFC
2018-07-05 11:37:50 +01:00
Oliver Schneider
e0df4ccfc5 Use the new scoped tool attributes 2018-05-19 14:04:57 +02:00
Manish Goregaokar
1af2f20da6
include contributing.md blurb from https://github.com/hashicorp/vault/blob/master/CONTRIBUTING.md 2018-05-14 12:11:56 -05:00
Oliver Schneider
18a5b90242
Merge pull request #2712 from rust-lang-nursery/oli-obk-patch-1
Deprecate plugin-clippy
2018-05-12 11:13:37 +02:00
Philipp Hansch
fa0d9c5782
Explain how to debug and fix nightly build failures 2018-05-12 10:35:35 +02:00
Oliver Schneider
fd8a1d20cc
Remove all mention and testing of #[plugin(clippy)] and warn if used 2018-05-11 13:20:39 +02:00
Philipp Hansch
6f47cb1102
Add TOC to contribution instructions
Also changed some headings and re-ordered the paragraphs in the testing
guide.

(I used [vim-markdown-toc](https://github.com/mzlogin/vim-markdown-toc) to
generate it automatically.)
2018-04-27 22:12:09 +02:00
Philipp Hansch
36233789d4
Mention util/update_lints.py 2018-04-24 21:04:43 +02:00
Philipp Hansch
5bfb306b4b
Explain how Clippy works 2018-04-21 11:53:15 +02:00
Philipp Hansch
fe426b7c51
Add intro and mention IRC in CONTRIBUTING.md
This is partly taken from the [rustfmt CONTRIBUTING.md][contrib].

[contrib]: https://github.com/rust-lang-nursery/rustfmt/blob/master/Contributing.md
2018-04-17 08:33:22 +02:00
Manish Goregaokar
1c73db172a
fix other instance of internals docs 2018-04-03 22:47:27 -07:00
Manish Goregaokar
c170e86403
new internals docs 2018-04-03 19:05:33 -07:00
Philipp Hansch
b1b0b36cc0
Document the author lint 2018-04-02 14:55:00 +02:00
Philipp Hansch
872db029cf
Improve CONTRIBUTING.md
* Incremental compilation is on by default
* Restructured the label overview to go from easy to more difficult labels.
2018-04-01 15:31:25 +02:00
Philipp Hansch
0b4e0b82a9
Explain how to execute a single UI test 2018-02-13 22:33:42 +01:00
Georg Brandl
3d26c7bb7f CONTRIBUTING: clarify how to regenerate ui test output 2017-11-18 16:11:07 +01:00
Oliver Schneider
4d9ed8beef E-easy -> "good first issue" issue label 2017-10-17 15:32:50 +02:00
Niklas Fiekas
ff25013384 Fix manual testing command in docs 2017-10-08 12:05:30 +02:00
Joonas Koivunen
58a94ea562 CONTRIBUTING: add manual testing section 2017-08-24 18:17:35 +03:00
Oliver Schneider
4470d7a8ca Merge branch 'master' into move_links 2017-08-14 10:07:26 +02:00
Oliver Schneider
ce80b23e09 Update CONTRIBUTING.md 2017-08-07 17:33:27 +02:00
Andre Bogus
f515d7bb67 Change all links to reflect the move to rust-lang-nursery 2017-08-06 23:10:55 +02:00
Oliver Schneider
70cc9509c1
Revert "Update contribution instructions to the new system"
This reverts commit 5ed2066dca.
2017-08-02 12:46:06 +02:00
Oliver Schneider
5ed2066dca Update contribution instructions to the new system 2017-05-23 13:19:16 +02:00
Oliver Schneider
713fa53fd2 Update CONTRIBUTING.md 2017-03-14 16:25:40 +01:00
Oliver Schneider
6dfd6f13ec make statement about *.stderr files clearer 2017-02-08 08:44:57 +01:00
Oliver Schneider
fd1351f6e3 rustup and compile-fail -> ui test move 2017-02-07 21:05:30 +01:00
Georg Brandl
3b5ff0f813 Make the lint docstrings more consistent. 2016-08-07 08:06:19 +02:00
mcarton
81b9b2ca85
s/``/``rust when relevant
It looks better on the wiki/the new documentation page.
2016-07-29 20:37:25 +02:00
Manish Goregaokar
ae24929cd6 Update contributing with new links 2016-03-28 02:00:35 +05:30
josephDunne
aa819b7748 Update rust-clippy to rustc 1.9.0-nightly (d5a91e695 2016-03-26)
move cfg, infer, traits and ty from middle to top-level
move middle::subst into middle::ty
track the extern-crate def-id rather than path (rustc ab9b844)
2016-03-27 20:24:10 +01:00
Manish Goregaokar
ea03c0d9e3 Merge pull request #514 from mcarton/remove-dup
Remove dup
2015-12-22 10:18:12 +05:30
mcarton
934ead14b5 Fix typo 2015-12-22 00:51:15 +01:00
mcarton
826827fe94 Fix some typos 2015-12-21 20:47:19 +01:00
llogiq
dc9a08fc78 Add short section on lint docs 2015-12-14 22:23:33 +01:00
llogiq
6f8d47b411 add a few words on dogfood + update_lints 2015-08-14 11:30:39 +02:00
Manish Goregaokar
854212ce85 Update CONTRIBUTING.md 2015-08-12 03:32:20 +05:30
Manish Goregaokar
940c713f66 Update CONTRIBUTING.md 2015-08-11 18:35:05 +05:30
Manish Goregaokar
678a79d45a CONTRIBUTING 2015-08-11 18:33:56 +05:30