From 1f2a2c82c6b26a902ce458c5eaf50d7113853b33 Mon Sep 17 00:00:00 2001 From: Mark Mentovai Date: Mon, 7 Nov 2016 08:49:01 -0500 Subject: [PATCH] doc: Small updates after Markdown migration MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The strangest discovery relates to the #

title in navbar.md. Gitiles renders it small unless there’s a [home] reference, so use that. This should only affect wrapping the site logo in the [home] link, but it appears to control the size of the navbar title too. See https://code.google.com/p/gitiles/issues/detail?id=130. BUG=crashpad:138,gitiles:130 Change-Id: I11b3a79f045efa22358b3c3ef4b50ce2e6b3282e Reviewed-on: https://chromium-review.googlesource.com/408458 Reviewed-by: Robert Sesek --- doc/developing.md | 15 +++++++++------ handler/crashpad_handler.md | 7 +++---- navbar.md | 14 +++++++++----- tools/mac/run_with_crashpad.md | 6 +++--- 4 files changed, 24 insertions(+), 18 deletions(-) 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/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..a211eaac 100644 --- a/navbar.md +++ b/navbar.md @@ -14,8 +14,12 @@ 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/) + * [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