3party/crashpad
0
0
Fork 0
mirror of https://github.com/chromium/crashpad.git synced 2025-03-09 14:06:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update crashpad_handler man page to document all options.

Browse Source 
R=rsesek@chromium.org

Review URL: https://codereview.chromium.org/1009743004
This commit is contained in:
Mark Mentovai 2015-03-18 17:10:55 -04:00
parent c2502f45c9
commit c052c97c7e
3 changed files with 54 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
handler/mac/crash_report_upload_thread.cc
View File

@ -226,9 +226,11 @@ void CrashReportUploadThread::ProcessPendingReport(
Settings* const settings = database_->GetSettings();
bool uploads_enabled;
if (!settings->GetUploadsEnabled(&uploads_enabled) || !uploads_enabled) {
// If uploads are disabled or the upload-enabled state can’t be determined,
// don’t attempt to upload the new report.
if (!settings->GetUploadsEnabled(&uploads_enabled) ||
!uploads_enabled ||
url_.empty()) {
// If the upload-enabled state can’t be determined, uploads are disabled, or
// there’s no URL to upload to, don’t attempt to upload the new report.
database_->SkipReportUpload(report.uuid);
return;
}

55
handler/mac/crashpad_handler.ad
View File

@ -27,13 +27,19 @@ crashpad_handler - Crashpad’s exception handler server
== Description
This program is Crashpad’s main exception-handling server. This server is
normally started by its initial client, and it performs a handshake with this
client via a pipe established by the client that is inherited by the server,
referenced by the *--handshake-fd* argument. During the handshake, the server
furnishes the client with a send right that the client may use as an exception
port. The server retains the corresponding receive right, which it monitors for
exception messages. When the receive right loses all senders, the server exits.
This program is Crashpad’s main exception-handling server. It is responsible for
catching exceptions, writing crash reports, and uploading them to a crash report
collection server. Uploads are disabled by default, and can only be enabled by a
Crashpad client using the Crashpad client library, typically in response to a
user requesting this behavior.
This server is normally started by its initial client, and it performs a
handshake with this client via a pipe established by the client that is
inherited by the server, referenced by the *--handshake-fd* argument. During the
handshake, the server furnishes the client with a send right that the client may
use as an exception port. The server retains the corresponding receive right,
which it monitors for exception messages. When the receive right loses all
senders, the server exits after allowing any upload in progress to complete.
It is not normally appropriate to invoke this program directly. Usually, it will
be invoked by a Crashpad client using the Crashpad client library. Arbitrary
@ -41,8 +47,41 @@ programs may be run with a Crashpad handler by using run_with_crashpad(1) to
establish the Crashpad client environment before running a program.
== Options
*-h*, *--handshake-fd*='FD'::
*--annotation*='KEY=VALUE'::
Sets a process-level annotation mapping 'KEY' to 'VALUE' in each crash report
that is written. This option may appear zero, one, or multiple times.
+
Most annotations should be provided by the Crashpad client as module-level
annotations instead of process-level annotations. Module-level annotations are
more flexible in that they can be modified and cleared during the client
program’s lifetime. Module-level annotations can be set via the Crashpad client
library. Process-level annotations are useful for annotations that the
collection server requires be present, that have fixed values, and for cases
where a program that does not use the Crashpad client library is being
monitored.
+
Breakpad-type collection servers only require the +"prod"+ and +"ver"+
annotations, which should be set to the product name or identifier and product
version, respectively. It is unusual to specify other annotations as
process-level annotations via this argument.
*--database*='PATH'::
Use 'PATH' as the path to the Crashpad crash report database. This option is
required. Crash reports are written to this database, and if uploads are
enabled, uploaded from this database to a crash report collection server. If the
database does not exist, it will be created, provided that the parent directory
of 'PATH' exists.
*--handshake-fd*='FD'::
Perform the handshake with the initial client on the file descriptor at 'FD'.
This option is required.
*--url*='URL'::
If uploads are enabled, sends crash reports to the Breakpad-type crash report
collection server at 'URL'. Uploads are disabled by default, and can only be
enabled for a database by a Crashpad client using the Crashpad client library,
typically in response to a user requesting this behavior. If this option is not
specified, this program will behave as if uploads are disabled.
*--help*::
Display help and exit.

3
handler/mac/main.cc
View File

@ -45,7 +45,8 @@ void Usage(const std::string& me) {
" --annotation=KEY=VALUE set a process annotation in each crash report\n"
" --database=PATH store the crash report database at PATH\n"
" --handshake-fd=FD establish communication with the client over FD\n"
" --url=URL send crash reports to this Breakpad server URL\n"
" --url=URL send crash reports to this Breakpad server URL,\n"
" only if uploads are enabled for the database\n"
" --help display this help and exit\n"
" --version output version information and exit\n",
me.c_str());