mirror of
https://github.com/chromium/crashpad.git
synced 2024-12-27 15:32:10 +08:00
doc: Small updates after Markdown migration
The strangest discovery relates to the # <h1> 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 <rsesek@chromium.org>
This commit is contained in:
parent
05c89beaae
commit
1f2a2c82c6
@ -33,18 +33,18 @@ provides more detail.
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
To develop Crashpad, the following tools are necessary, and must be
|
To develop Crashpad, the following tools are necessary, and must be present in
|
||||||
present in the `$PATH` environment variable:
|
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
|
* Chromium’s
|
||||||
[depot_tools](https://dev.chromium.org/developers/how-tos/depottools).
|
[depot_tools](https://dev.chromium.org/developers/how-tos/depottools).
|
||||||
* [Git](https://git-scm.com/). This is provided by Xcode on macOS and by
|
* [Git](https://git-scm.com/). This is provided by Xcode on macOS and by
|
||||||
depot_tools on Windows.
|
depot_tools on Windows.
|
||||||
* [Python](https://www.python.org/). This is provided by the operating system
|
* [Python](https://www.python.org/). This is provided by the operating system
|
||||||
on macOS, and by depot_tools on Windows.
|
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
|
## Getting the Source Code
|
||||||
|
|
||||||
@ -300,7 +300,10 @@ Agreement](https://developers.google.com/open-source/cla/individual) or
|
|||||||
[Corporate Contributor License
|
[Corporate Contributor License
|
||||||
Agreement](https://developers.google.com/open-source/cla/corporate) as
|
Agreement](https://developers.google.com/open-source/cla/corporate) as
|
||||||
appropriate before any submission can be accepted, and must be listed in the
|
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
|
## Buildbot
|
||||||
|
|
||||||
|
@ -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
|
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
|
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
|
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
|
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
|
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
|
`.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
|
Either this option or **--mach-service**, but not both, is required. This
|
||||||
option is only valid on macOS.
|
option is only valid on macOS.
|
||||||
|
|
||||||
* **--initial-client-data**=*HANDLE_request_crash_dump*,
|
* **--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*
|
||||||
*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.
|
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
|
`CrashpadClient` and `ExceptionHandlerServer`. Either this option or
|
||||||
**--pipe-name**, but not both, is required. This option is only valid on
|
**--pipe-name**, but not both, is required. This option is only valid on
|
||||||
Windows.
|
Windows.
|
||||||
|
14
navbar.md
14
navbar.md
@ -14,8 +14,12 @@ See the License for the specific language governing permissions and
|
|||||||
limitations under the License.
|
limitations under the License.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
* [Home](/README.md)
|
# Crashpad
|
||||||
* [Developing](/doc/developing.md)
|
|
||||||
* [Doxygen](https://crashpad.chromium.org/doxygen/)
|
* [Home][home]
|
||||||
* [Man Pages](https://crashpad.chromium.org/man/)
|
* [Developing](/doc/developing.md)
|
||||||
* [Source Code](https://chromium.googlesource.com/crashpad/crashpad/)
|
* [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
|
||||||
|
@ -45,7 +45,7 @@ run with a Crashpad exception handler.
|
|||||||
|
|
||||||
* **-h**, **--handler**=_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**.
|
**crashpad_handler**.
|
||||||
|
|
||||||
* **--annotation**=_KEY=VALUE_
|
* **--annotation**=_KEY=VALUE_
|
||||||
@ -110,11 +110,11 @@ task exception port 0, mask 0x1c00 (CRASH|RESOURCE|GUARD), port 0x30b, behavior
|
|||||||
|
|
||||||
* **126**
|
* **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**
|
* **127**
|
||||||
|
|
||||||
The program specified by 'COMMAND' could not be found.
|
The program specified by _COMMAND_ could not be found.
|
||||||
|
|
||||||
## See Also
|
## See Also
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user