From f5e869c51f4ecbfcaa812b855a9e5a3500456eff Mon Sep 17 00:00:00 2001
From: Mark Mentovai <mark@chromium.org>
Date: Mon, 7 Nov 2016 13:44:36 -0500
Subject: [PATCH] doc: Check in the man page index instead of generating it
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The generated page’s benefit-to-complexity ratio was too low.

BUG=crashpad:138

Change-Id: I5324c33b6b7f83e973c40b256b06e25c763b23c4
Reviewed-on: https://chromium-review.googlesource.com/408268
Reviewed-by: Robert Sesek <rsesek@chromium.org>
---
 README.md               |  2 +-
 doc/appengine/main.go   |  4 ++++
 doc/man.md              | 33 ++++++++++++++++++++++++++++++
 doc/support/generate.sh | 45 -----------------------------------------
 navbar.md               |  1 +
 5 files changed, 39 insertions(+), 46 deletions(-)
 create mode 100644 doc/man.md

diff --git a/README.md b/README.md
index c7be545e..57e81695 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@ limitations under the License.
  * [Developing Crashpad](doc/developing.md): instructions for getting the source
    code, building, testing, and contributing to the project.
  * [Crashpad interface documentation](https://crashpad.chromium.org/doxygen/)
- * [Crashpad tool man pages](https://crashpad.chromium.org/man/)
+ * [Crashpad tool man pages](doc/man.md)
 
 ## Source Code
 
diff --git a/doc/appengine/main.go b/doc/appengine/main.go
index adcf6716..a33f70fe 100644
--- a/doc/appengine/main.go
+++ b/doc/appengine/main.go
@@ -50,11 +50,15 @@ func handler(w http.ResponseWriter, r *http.Request) {
 		"/bug/new":                         bugBaseURL + "issues/entry",
 		"/doc/developing.html":             masterBaseURL + "/doc/developing.md",
 		"/doc/status.html":                 masterBaseURL + "/doc/status.md",
+		"/index.html":                      masterBaseURL + "README.md",
+		"/man":                             masterBaseURL + "doc/man.md",
+		"/man/":                            masterBaseURL + "doc/man.md",
 		"/man/catch_exception_tool.html":   masterBaseURL + "tools/mac/catch_exception_tool.md",
 		"/man/crashpad_database_util.html": masterBaseURL + "tools/crashpad_database_util.md",
 		"/man/crashpad_handler.html":       masterBaseURL + "handler/crashpad_handler.md",
 		"/man/exception_port_tool.html":    masterBaseURL + "tools/mac/exception_port_tool.md",
 		"/man/generate_dump.html":          masterBaseURL + "tools/generate_dump.md",
+		"/man/index.html":                  masterBaseURL + "doc/man.md",
 		"/man/on_demand_service_tool.html": masterBaseURL + "tools/mac/on_demand_service_tool.md",
 		"/man/run_with_crashpad.html":      masterBaseURL + "tools/mac/run_with_crashpad.md",
 	}
diff --git a/doc/man.md b/doc/man.md
new file mode 100644
index 00000000..ff5fd413
--- /dev/null
+++ b/doc/man.md
@@ -0,0 +1,33 @@
+<!--
+Copyright 2016 The Crashpad Authors. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Man Pages
+
+## Section 1: User Commands
+
+ * [crashpad_database_util](../tools/crashpad_database_util.md)
+ * [generate_dump](../tools/generate_dump.md)
+
+### macOS-Specific
+
+ * [catch_exception_tool](../tools/mac/catch_exception_tool.md)
+ * [exception_port_tool](../tools/mac/exception_port_tool.md)
+ * [on_demand_service_tool](../tools/mac/on_demand_service_tool.md)
+ * [run_with_crashpad](../tools/mac/run_with_crashpad.md)
+
+## Section 8: Dӕmons
+
+ * [crashpad_handler](../handler/crashpad_handler.md)
diff --git a/doc/support/generate.sh b/doc/support/generate.sh
index 0f77a4a8..aa3d7035 100755
--- a/doc/support/generate.sh
+++ b/doc/support/generate.sh
@@ -44,48 +44,3 @@ rm -f "${output_dir}/index.html"
 
 # Ensure a favicon exists at the root since the browser will always request it.
 cp doc/favicon.ico "${output_dir}/"
-
-# Create man/index.html. Do this in two steps so that the built-up list of man
-# pages can be sorted according to the basename, not the entire path.
-list_file=$(mktemp)
-for man_path in $(find . -name '*.md' |
-                  ${sed_ext} -e 's%^\./%%' |
-                  grep -Ev '^(README.md$|(third_party|doc)/)'); do
-  # These should show up in all man pages, but probably not all together in any
-  # other Markdown documents.
-  if ! (grep -q '^## Name$' "${man_path}" &&
-        grep -q '^## Synopsis$' "${man_path}" &&
-        grep -q '^## Description$' "${man_path}"); then
-    continue
-  fi
-
-  man_basename=$(${sed_ext} -e 's/\.md$//' <<< $(basename "${man_path}"))
-  cat >> "${list_file}" << __EOF__
-<!-- ${man_basename} --><a href="https://chromium.googlesource.com/crashpad/crashpad/+/master/${man_path}">${man_basename}</a>
-__EOF__
-done
-
-maybe_mkdir "${output_dir}/man"
-
-cd "${output_dir}/man"
-cat > index.html << __EOF__
-<!DOCTYPE html>
-<meta charset="utf-8">
-<title>Crashpad Man Pages</title>
-<ul>
-__EOF__
-
-sort "${list_file}" | while read line; do
-  line=$(${sed_ext} -e 's/^<!-- .* -->//' <<< "${line}")
-  cat >> index.html << __EOF__
-  <li>
-${line}
-  </li>
-__EOF__
-done
-
-rm -f "${list_file}"
-
-cat >> index.html << __EOF__
-</ul>
-__EOF__
diff --git a/navbar.md b/navbar.md
index a211eaac..8eb7e1c4 100644
--- a/navbar.md
+++ b/navbar.md
@@ -20,6 +20,7 @@ limitations under the License.
  * [Developing](/doc/developing.md)
  * [Interface Docs](https://crashpad.chromium.org/doxygen/)
  * [Man Pages](https://crashpad.chromium.org/man/)
+ * [Man Pages](/doc/man.md)
  * [Source Code](https://chromium.googlesource.com/crashpad/crashpad/)
 
 [home]: /README.md