Auto merge of #5486 - ehuss:deprecate-doc, r=matklad

Deprecate `doc` profile.

Fixes #5434

Author: bors

src/cargo/util/toml/mod.rs

@@ -416,6 +416,9 @@ impl TomlProfile {
         }
 
         match name {
+            "doc" => {
+                warnings.push("profile `doc` is deprecated and has no effect".to_string());
+            }
             "test" | "bench" => {
                 if self.panic.is_some() {
                     warnings.push(format!("`panic` setting is ignored for `{}` profile", name))

src/doc/src/reference/manifest.md

@@ -294,7 +294,7 @@ project’s profiles are actually read. All dependencies’ profiles will be
 overridden. This is done so the top-level project has control over how its
 dependencies are compiled.
 
-There are five currently supported profile names, all of which have the same
+There are four currently supported profile names, all of which have the same
 configuration available to them. Listed below is the configuration available,
 along with the defaults for each profile.
 
@@ -357,18 +357,6 @@ codegen-units = 16
 panic = 'unwind'
 incremental = false
 overflow-checks = false
-
-# The documentation profile, used for `cargo doc`.
-[profile.doc]
-opt-level = 0
-debug = 2
-rpath = false
-lto = false
-debug-assertions = true
-codegen-units = 16
-panic = 'unwind'
-incremental = true
-overflow-checks = true
 ```
 
 ### The `[features]` section

tests/testsuite/profile_targets.rs

@@ -32,8 +32,6 @@ fn all_target_project() -> Project {
             codegen-units = 3
             [profile.bench]
             codegen-units = 4
-            [profile.doc]
-            codegen-units = 5
         "#,
         )
         .file("src/lib.rs", "extern crate bar;")

tests/testsuite/profiles.rs

@@ -371,3 +371,28 @@ fn profile_panic_test_bench() {
         ),
     );
 }
+
+#[test]
+fn profile_doc_deprecated() {
+    let p = project("foo")
+        .file(
+            "Cargo.toml",
+            r#"
+            [package]
+            name = "foo"
+            version = "0.0.1"
+
+            [profile.doc]
+            opt-level = 0
+        "#,
+        )
+        .file("src/lib.rs", "")
+        .build();
+
+    assert_that(
+        p.cargo("build"),
+        execs()
+            .with_status(0)
+            .with_stderr_contains("[WARNING] profile `doc` is deprecated and has no effect"),
+    );
+}