Merge pull request rust-lang#3171 from lqd/whitespace_jam

normalize_doc_attributes: remove whitespace from the doc comment opener

Author: nrc

src/attr.rs

@@ -326,7 +326,11 @@ impl Rewrite for ast::Attribute {
                             ast::AttrStyle::Outer => CommentStyle::TripleSlash,
                         };
 
-                        let doc_comment = format!("{}{}", comment_style.opener(), literal);
+                        // Remove possible whitespace from the `CommentStyle::opener()` so that
+                        // the literal itself has control over the comment's leading spaces.
+                        let opener = comment_style.opener().trim_end();
+
+                        let doc_comment = format!("{}{}", opener, literal);
                         return rewrite_doc_comment(
                             &doc_comment,
                             shape.comment(context.config),

tests/source/doc-attrib.rs

@@ -2,41 +2,42 @@
 // rustfmt-normalize_doc_attributes: true
 
 // Only doc = "" attributes should be normalized
-#![doc = "Example doc attribute comment"]
+#![doc = " Example doc attribute comment"]
+#![doc = "          Example doc attribute comment with 10 leading spaces"]
 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
        html_root_url = "https://doc.rust-lang.org/nightly/",
        html_playground_url = "https://play.rust-lang.org/", test(attr(deny(warnings))))]
 
 
 // Long `#[doc = "..."]`
-struct A { #[doc = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"] b: i32 }
+struct A { #[doc = " xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"] b: i32 }
 
 
-#[doc = "The `nodes` and `edges` method each return instantiations of `Cow<[T]>` to leave implementers the freedom to create entirely new vectors or to pass back slices into internally owned vectors."]
+#[doc = " The `nodes` and `edges` method each return instantiations of `Cow<[T]>` to leave implementers the freedom to create entirely new vectors or to pass back slices into internally owned vectors."]
 struct B { b: i32 }
 
 
-#[doc = "Level 1 comment"]
+#[doc = " Level 1 comment"]
 mod tests {
-    #[doc = "Level 2 comment"]
+    #[doc = " Level 2 comment"]
     impl A {
-        #[doc = "Level 3 comment"]
+        #[doc = " Level 3 comment"]
         fn f() {
-            #[doc = "Level 4 comment"]
+            #[doc = " Level 4 comment"]
             fn g() {
             }
         }
     }
 }
 
 struct C {
-    #[doc = "item doc attrib comment"]
+    #[doc = " item doc attrib comment"]
     // regular item comment
     b: i32,
 
     // regular item comment
-    #[doc = "item doc attrib comment"]
+    #[doc = " item doc attrib comment"]
     c: i32,
 }
 
@@ -89,3 +90,30 @@ pub struct Params {
                   all(target_arch = "wasm32", feature = "wasm-bindgen"),
               ))))]
 type Os = NoSource;
+
+// use cases from bindgen needing precise control over leading spaces
+#[doc = " <div rustbindgen accessor></div>"]
+#[repr(C)]
+#[derive(Debug, Default, Copy, Clone)]
+pub struct ContradictAccessors {
+    #[doc = "<foo>no leading spaces here</foo>"]
+    pub mBothAccessors: ::std::os::raw::c_int,
+    #[doc = " <div rustbindgen accessor=\"false\"></div>"]
+    pub mNoAccessors: ::std::os::raw::c_int,
+    #[doc = " <div rustbindgen accessor=\"unsafe\"></div>"]
+    pub mUnsafeAccessors: ::std::os::raw::c_int,
+    #[doc = " <div rustbindgen accessor=\"immutable\"></div>"]
+    pub mImmutableAccessor: ::std::os::raw::c_int,
+}
+
+#[doc = " \\brief          MPI structure"]
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct mbedtls_mpi {
+    #[doc = "<  integer sign"]
+    pub s: ::std::os::raw::c_int,
+    #[doc = "<  total # of limbs"]
+    pub n: ::std::os::raw::c_ulong,
+    #[doc = "<  pointer to limbs"]
+    pub p: *mut mbedtls_mpi_uint,
+}

tests/target/doc-attrib.rs

@@ -3,6 +3,7 @@
 
 // Only doc = "" attributes should be normalized
 //! Example doc attribute comment
+//!          Example doc attribute comment with 10 leading spaces
 #![doc(
     html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
     html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
@@ -103,3 +104,30 @@ mod issue_2620 {
     )
 )))]
 type Os = NoSource;
+
+// use cases from bindgen needing precise control over leading spaces
+/// <div rustbindgen accessor></div>
+#[repr(C)]
+#[derive(Debug, Default, Copy, Clone)]
+pub struct ContradictAccessors {
+    ///<foo>no leading spaces here</foo>
+    pub mBothAccessors: ::std::os::raw::c_int,
+    /// <div rustbindgen accessor="false"></div>
+    pub mNoAccessors: ::std::os::raw::c_int,
+    /// <div rustbindgen accessor="unsafe"></div>
+    pub mUnsafeAccessors: ::std::os::raw::c_int,
+    /// <div rustbindgen accessor="immutable"></div>
+    pub mImmutableAccessor: ::std::os::raw::c_int,
+}
+
+/// \brief          MPI structure
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct mbedtls_mpi {
+    ///<  integer sign
+    pub s: ::std::os::raw::c_int,
+    ///<  total # of limbs
+    pub n: ::std::os::raw::c_ulong,
+    ///<  pointer to limbs
+    pub p: *mut mbedtls_mpi_uint,
+}