mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge #10218

Browse Source 
10218: minor: Don't spam the manual with warnings r=lnicola a=lnicola

A single warning on the first line should™ be enough. Currently we put that warning on every section, while also breaking the table of contents in the process:

![image](https://user-images.githubusercontent.com/308347/133045747-5232ce04-7856-40fd-a82f-adcefb7a6f5a.png)

Fixes #9657

Co-authored-by: Laurențiu Nicola <lnicola@dend.ro>
This commit is contained in:
bors[bot] 2021-09-13 07:58:28 +00:00 committed by GitHub
commit c45792ae8f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/user/manual.adoc
View File

@ -1,3 +1,5 @@
// IMPORTANT: the master copy of this document lives in the https://github.com/rust-analyzer/rust-analyzer repository
= User Manual
:toc: preamble
:sectanchors:
@ -623,7 +625,7 @@ Note that calls to `cargo check` are disabled when using `rust-project.json` by
{ "rust-analyzer.checkOnSave.overrideCommand": ["cargo", "check", "--message-format=json"] }
----
The `checkOnSave.overrideCommand` requires the command specified to output json error messages for rust-analyzer to consume. The `--message-format=json` flag does this for `cargo check` so whichever command you use must also output errors in this format. See the <<Configuration>> section for more information.
The `checkOnSave.overrideCommand` requires the command specified to output json error messages for rust-analyzer to consume. The `--message-format=json` flag does this for `cargo check` so whichever command you use must also output errors in this format. See the <<Configuration>> section for more information.
== Security

2
xtask/src/release.rs
View File

@ -45,7 +45,7 @@ impl flags::Release {
let src = project_root().join("./docs/user/").join(adoc);
let dst = website_root.join(adoc);
let contents = read_file(src)?.replace("\n\n===", "\n\n// IMPORTANT: master copy of this document lives in the https://github.com/rust-analyzer/rust-analyzer repository\n\n==");
let contents = read_file(src)?;
write_file(dst, contents)?;
}