From 3e5e5b570a7625808b2bbe3c8ccaae78add584a1 Mon Sep 17 00:00:00 2001
From: Mark Mentovai <mark@chromium.org>
Date: Thu, 8 Oct 2015 14:38:10 -0400
Subject: [PATCH] Add doc/support/generate.sh

This script populates doc/generated. This directory is named in
.gitignore on the master branch, but will not be ignored on the doc
branch. The plan is to merge master into doc and run this script to
generate and check in a new set of generated docs.

BUG=crashpad:67
R=rsesek@chromium.org

Review URL: https://codereview.chromium.org/1397683003 .
---
 doc/.gitignore                   |  1 +
 doc/support/compat.sh            | 39 +++++++++++++++++
 doc/support/generate.sh          | 72 ++++++++++++++++++++++++++++++++
 doc/support/generate_asciidoc.sh | 22 +---------
 4 files changed, 114 insertions(+), 20 deletions(-)
 create mode 100644 doc/.gitignore
 create mode 100644 doc/support/compat.sh
 create mode 100755 doc/support/generate.sh

diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 00000000..e324eac9
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1 @@
+/generated
diff --git a/doc/support/compat.sh b/doc/support/compat.sh
new file mode 100644
index 00000000..e7135239
--- /dev/null
+++ b/doc/support/compat.sh
@@ -0,0 +1,39 @@
+#!/bin/bash
+
+# Copyright 2015 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.
+
+if [[ "${BASH_SOURCE[0]}" = "${0}" ]]; then
+  echo "${0}: this file must be sourced, not run directly" >& 2
+  exit 1
+fi
+
+# Some extensions of command-line tools behave differently on different systems.
+# $sed_ext should be a sed invocation that enables extended regular expressions.
+# $date_time_t should be a date invocation that causes it to print the date and
+# time corresponding to a time_t string that immediately follows it.
+case "$(uname -s)" in
+  Darwin)
+    sed_ext="sed -E"
+    date_time_t="date -r"
+    ;;
+  Linux)
+    sed_ext="sed -r"
+    date_time_t="date -d@"
+    ;;
+  *)
+    echo "${0}: unknown operating system" >& 2
+    exit 1
+    ;;
+esac
diff --git a/doc/support/generate.sh b/doc/support/generate.sh
new file mode 100755
index 00000000..dcb74375
--- /dev/null
+++ b/doc/support/generate.sh
@@ -0,0 +1,72 @@
+#!/bin/bash
+
+# Copyright 2015 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.
+
+set -e
+
+function maybe_mkdir() {
+  local dir="${1}"
+  if [[ ! -d "${dir}" ]]; then
+    mkdir "${dir}"
+  fi
+}
+
+# Run from the Crashpad project root directory.
+cd "$(dirname "${0}")/../.."
+
+source doc/support/compat.sh
+
+doc/support/generate_doxygen.sh
+doc/support/generate_asciidoc.sh
+
+output_dir=doc/generated
+maybe_mkdir "${output_dir}"
+
+for subdir in doc doxygen man ; do
+  output_subdir="${output_dir}/${subdir}"
+  maybe_mkdir "${output_subdir}"
+  rsync -Ilr --delete --exclude .git "out/doc/${subdir}/html/" \
+      "${output_subdir}/"
+done
+
+# Move doc/index.html to index.html, adjusting relative paths to other files in
+# doc.
+${sed_ext} -e 's%<a href="([^/]+)\.html">%<a href="doc/\1.html">%g' \
+    < "${output_dir}/doc/index.html" > "${output_dir}/index.html"
+
+# Create man/index.html
+cd "${output_dir}/man"
+cat > index.html << __EOF__
+<!DOCTYPE html>
+<meta charset="utf-8">
+<title>Crashpad Man Pages</title>
+<ul>
+__EOF__
+
+for html_file in *.html; do
+  if [[ "${html_file}" = "index.html" ]]; then
+    continue
+  fi
+  basename=$(${sed_ext} -e 's/\.html$//' <<< "${html_file}")
+  cat >> index.html << __EOF__
+  <li>
+    <a href="${html_file}">${basename}</a>
+  </li>
+__EOF__
+done
+
+cat >> index.html << __EOF__
+</ul>
+__EOF__
diff --git a/doc/support/generate_asciidoc.sh b/doc/support/generate_asciidoc.sh
index b636fe70..54a57349 100755
--- a/doc/support/generate_asciidoc.sh
+++ b/doc/support/generate_asciidoc.sh
@@ -23,6 +23,8 @@ set -e
 # Run from the Crashpad project root directory.
 cd "$(dirname "${0}")/../.."
 
+source doc/support/compat.sh
+
 output_dir=out/doc
 
 rm -rf \
@@ -33,26 +35,6 @@ mkdir -p \
     "${output_dir}/man/html" \
     "${output_dir}/man/man"
 
-# Some extensions of command-line tools behave differently on different systems.
-# $sed_ext should be a sed invocation that enables extended regular expressions.
-# $date_time_t should be a date invocation that causes it to print the date and
-# time corresponding to a time_t string that immediately follows it.
-uname_s="$(uname -s)"
-case "${uname_s}" in
-  Darwin)
-    sed_ext="sed -E"
-    date_time_t="date -r"
-    ;;
-  Linux)
-    sed_ext="sed -r"
-    date_time_t="date -d@"
-    ;;
-  *)
-    echo "${0}: unknown operating system" >& 2
-    exit 1
-    ;;
-esac
-
 # Get the version from package.h.
 version=$(${sed_ext} -n -e 's/^#define PACKAGE_VERSION "(.*)"$/\1/p' package.h)