rustdoc: Emit keywords for all crate pages

brson · brson · commit 57e53d5c2f76 · 2014-08-04T14:37:07.000-07:00
cc #12466
diff --git a/src/librustdoc/html/layout.rs b/src/librustdoc/html/layout.rs
@@ -26,7 +26,8 @@ pub struct Page<'a> {
     pub title: &'a str,
     pub ty: &'a str,
     pub root_path: &'a str,
-    pub description: &'a str
+    pub description: &'a str,
+    pub keywords: &'a str
 }
 
 pub fn render<T: fmt::Show, S: fmt::Show>(
@@ -41,6 +42,7 @@ r##"<!DOCTYPE html>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="rustdoc">
     <meta name="description" content="{description}">
+    <meta name="keywords" content="{keywords}">
 
     <title>{title}</title>
 
@@ -137,6 +139,7 @@ r##"<!DOCTYPE html>
     },
     title     = page.title,
     description = page.description,
+    keywords = page.keywords,
     favicon   = if layout.favicon.len() == 0 {
         "".to_string()
     } else {
diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs
@@ -748,6 +748,7 @@ impl<'a> SourceCollector<'a> {
             ty: "source",
             root_path: root_path.as_slice(),
             description: desc.as_slice(),
+            keywords: get_basic_keywords(),
         };
         try!(layout::render(&mut w as &mut Writer, &self.cx.layout,
                             &page, &(""), &Source(contents)));
@@ -1081,6 +1082,7 @@ impl Context {
                 root_path: this.root_path.as_slice(),
                 title: title.as_slice(),
                 description: desc.as_slice(),
+                keywords: get_basic_keywords(),
             };
             let html_dst = &this.dst.join("stability.html");
             let mut html_out = BufferedWriter::new(try!(File::create(html_dst)));
@@ -1137,11 +1139,13 @@ impl Context {
                 format!("API documentation for the Rust `{}` {} in crate `{}`.",
                         it.name.get_ref(), tyname, cx.layout.krate)
             };
+            let keywords = make_item_keywords(it);
             let page = layout::Page {
                 ty: tyname,
                 root_path: cx.root_path.as_slice(),
                 title: title.as_slice(),
                 description: desc.as_slice(),
+                keywords: keywords.as_slice(),
             };
 
             markdown::reset_headers();
@@ -2170,3 +2174,11 @@ fn ignore_private_item(it: &clean::Item) -> bool {
         _ => false,
     }
 }
+
+fn get_basic_keywords() -> &'static str {
+    "rust, rustlang, rust-lang"
+}
+
+fn make_item_keywords(it: &clean::Item) -> String {
+    format!("{}, {}", get_basic_keywords(), it.name.get_ref())
+}
