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/developing.md b/doc/developing.md index 737f819f..229e7b00 100644 --- a/doc/developing.md +++ b/doc/developing.md @@ -33,18 +33,18 @@ provides more detail. ## Prerequisites -To develop Crashpad, the following tools are necessary, and must be -present in the `$PATH` environment variable: +To develop Crashpad, the following tools are necessary, and must be present in +the `$PATH` environment variable: + * Appropriate development tools. For macOS, this is + [Xcode](https://developer.apple.com/xcode/) and for Windows, it’s [Visual + Studio](https://www.visualstudio.com/). * Chromium’s [depot_tools](https://dev.chromium.org/developers/how-tos/depottools). * [Git](https://git-scm.com/). This is provided by Xcode on macOS and by depot_tools on Windows. * [Python](https://www.python.org/). This is provided by the operating system on macOS, and by depot_tools on Windows. - * Appropriate development tools. For macOS, this is - [Xcode](https://developer.apple.com/xcode/) and for Windows, it’s [Visual - Studio](https://www.visualstudio.com/). ## Getting the Source Code @@ -300,7 +300,10 @@ Agreement](https://developers.google.com/open-source/cla/individual) or [Corporate Contributor License Agreement](https://developers.google.com/open-source/cla/corporate) as appropriate before any submission can be accepted, and must be listed in the -`AUTHORS` file. Contributors may be listed in the `CONTRIBUTORS` file. +[`AUTHORS`](https://chromium.googlesource.com/crashpad/crashpad/+/master/AUTHORS) +file. Contributors may be listed in the +[`CONTRIBUTORS`](https://chromium.googlesource.com/crashpad/crashpad/+/master/CONTRIBUTORS) +file. ## Buildbot 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 @@ + + +# 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} -__EOF__ -done - -maybe_mkdir "${output_dir}/man" - -cd "${output_dir}/man" -cat > index.html << __EOF__ - - -Crashpad Man Pages - -__EOF__ diff --git a/handler/crashpad_handler.md b/handler/crashpad_handler.md index 914d7be4..31c0b347 100644 --- a/handler/crashpad_handler.md +++ b/handler/crashpad_handler.md @@ -66,7 +66,7 @@ allowing any upload in progress to complete. On Windows, this executable is built by default as a Windows GUI app, so no console will appear in normal usage. This is the version that will typically be used. A second copy is also made with a `.com` extension, rather than `.exe`. In -this second copy, the PE header is modified to indicate that it's a console app. +this second copy, the PE header is modified to indicate that it’s a console app. This is useful because the `.com` is found in the path before the `.exe`, so when run normally from a shell using only the basename (without an explicit `.com` or `.exe` extension), the `.com` console version will be chosen, and so @@ -114,11 +114,10 @@ establish the Crashpad client environment before running a program. Either this option or **--mach-service**, but not both, is required. This option is only valid on macOS. - * **--initial-client-data**=*HANDLE_request_crash_dump*, -*HANDLE_request_non_crash_dump_*,*HANDLE_non_crash_dump_completed*,*HANDLE_first_pipe_instance*,*HANDLE_client_process*,*Address_crash_exception_information*,*Address_non_crash_exception_information*,*Address_debug_critical_section* + * **--initial-client-data**=*HANDLE_request_crash_dump*,*HANDLE_request_non_crash_dump*,*HANDLE_non_crash_dump_completed*,*HANDLE_first_pipe_instance*,*HANDLE_client_process*,*Address_crash_exception_information*,*Address_non_crash_exception_information*,*Address_debug_critical_section* Register the initial client using the inherited handles and data provided. - For more information on the arguments, see the implementations of + For more information on the argument’s format, see the implementations of `CrashpadClient` and `ExceptionHandlerServer`. Either this option or **--pipe-name**, but not both, is required. This option is only valid on Windows. diff --git a/navbar.md b/navbar.md index e3c3d97b..8eb7e1c4 100644 --- a/navbar.md +++ b/navbar.md @@ -14,8 +14,13 @@ See the License for the specific language governing permissions and limitations under the License. --> -* [Home](/README.md) -* [Developing](/doc/developing.md) -* [Doxygen](https://crashpad.chromium.org/doxygen/) -* [Man Pages](https://crashpad.chromium.org/man/) -* [Source Code](https://chromium.googlesource.com/crashpad/crashpad/) +# Crashpad + + * [Home][home] + * [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 diff --git a/tools/mac/run_with_crashpad.md b/tools/mac/run_with_crashpad.md index 0efcc371..c87cb150 100644 --- a/tools/mac/run_with_crashpad.md +++ b/tools/mac/run_with_crashpad.md @@ -45,7 +45,7 @@ run with a Crashpad exception handler. * **-h**, **--handler**=_HANDLER_ - Invoke 'HANDLER' as the Crashpad handler program instead of the default, + Invoke _HANDLER_ as the Crashpad handler program instead of the default, **crashpad_handler**. * **--annotation**=_KEY=VALUE_ @@ -110,11 +110,11 @@ task exception port 0, mask 0x1c00 (CRASH|RESOURCE|GUARD), port 0x30b, behavior * **126** - The program specified by 'COMMAND' was found, but could not be invoked. + The program specified by _COMMAND_ was found, but could not be invoked. * **127** - The program specified by 'COMMAND' could not be found. + The program specified by _COMMAND_ could not be found. ## See Also