mirror of
https://github.com/chromium/crashpad.git
synced 2025-03-09 14:06:33 +00:00
e428b3ad13
doc/support/crashpad.doxy is updated with:
```
% doxygen -u doc/support/crashpad.doxy
[…]
% doxygen -v
1.13.2
```
Additional updates to doc/support/crashpad.doxy are made:
- The settings for `DISABLE_INDEX` and `GENERATE_TREEVIEW` are updated,
as Doxygen’s defaults have changed. This switches from the
top-of-page index to the side-of-page tree view.
- The TODO and Deprecated sections have become more prominent under the
side-of-page tree view than they were with the top-of-page index, and
they’re not very useful in Crashpad documentation, so they’re
disabled by setting `GENERATE_TODOLIST` and `GENERATE_DEPRECATEDLIST`
appropriately. The similar (but unused in Crashpad)
`GENERATE_TESTLIST` and `GENERATE_BUGLIST` are also disabled.
- `USE_DOT` is now set, to use `dot` from GraphViz to generate SVG
diagrams. These look better than the PNGs that Doxygen generated
without `dot`. `DOT_COMMON_ATTR` and `DOT_EDGE_ATTR` are set to make
the fonts used in GraphViz-generated SVGs match those used in
Doxygen-generated HTML/CSS.
- `EXCLUDE` has been updated to drop directories that no longer exist
(compat/non_cxx11_lib) and add ones that now do (compat/android,
compat/ios, and compat/linux).
- Some values that were otherwise unused in doc/support/crashpad.doxy
are set back to their default values. The differences from the
default configuration are shown with `doxygen -x
doc/support/crashpad.doxy`, and a configuration template with default
values can be generated for inspection with `doxygen -g
/tmp/template.doxy`. The tags affected are:
- `MATHJAX_RELPATH`, unused since `USE_MATHJAX` is `NO`.
- `LATEX_CMD_NAME` and `LATEX_BIB_STYLE`, unused since `USE_LATEX`
is `NO`).
- `EXCLUDE_PATTERNS`, unused since `EXCLUDE_PATH` is empty.
doc/support/doxygen_crashpad.css is updated to change the non-monospaced
font from Open Sans to Noto Sans. It is also updated to use the CSS
properties Doxygen defines for the purpose, rather than monkeying around
with custom selectors. The properties can be discovered by running
`doxygen -w html header.html footer.html customdoxygen.css
doc/support/crashpad.doxy` and reviewing customdoxygen.css.
doc/support/generate.sh is updated to further execute
doc/support/generate_doxygen.py by invoking directly and relying on its
`#!/usr/bin/env python3` line rather than invoking via `python`, which
is no longer available on many systems. doc/support/generate_doxygen.py
has already been Python 3-compatible since f88a116c0e2e
(https://chromium-review.googlesource.com/c/3542572, 2022-03-23).
Finally, there are a number of changes to fix Doxygen warnings produced
by the new Doxygen version or because of new code that has not yet been
run through Doxygen during a test run.
Change-Id: I436688b16530cb0a07dbf89d32601fff689ac2f2
Reviewed-on: https://chromium-review.googlesource.com/c/crashpad/crashpad/+/6180234
Reviewed-by: Justin Cohen <justincohen@chromium.org>
Reviewed-by: Joshua Peraza <jperaza@chromium.org>
Commit-Queue: Mark Mentovai <mark@chromium.org>
This is the App Engine app that serves https://crashpad.chromium.org/. To work on this app, obtain the following packages: - Go, from https://golang.org/dl/. This is only necessary for local development and testing. The directory containing the “go” executable, such as /usr/local/go/bin, must appear in $PATH. It does not appear critical for the Go version used to match the Go runtime version used (for example, these instructions were tested with Go 1.14 locally but a Go 1.11 runtime when deployed), but if problems are encountered, it would be wise to use the same version for both local development and AppEngine deployment. - The Google Cloud SDK (gcloud CLI) from https://cloud.google.com/sdk/docs/install-sdk. This is necessary for both local development and for AppEngine deployment. Unpacking this package produces a google-cloud-sdk directory, whose bin child directory may be added to $PATH for convenience, although this is not strictly necessary. The commands in this README are expected to be run from the directory containing it. To test locally: % go get -d ./src/crashpad-home % python3 …/google-cloud-sdk/bin/dev_appserver.py src/crashpad-home dev_appserver.py must be invoked using Python 3, but internally will use Python 2, and a Python 2 interpreter must be available in the PATH as python2. Look for the “Starting module "default" running at: http://localhost:8080” line, which tells you the URL of the local running instance of the app. Test http://localhost:8080/ to ensure that it works. It would be good to test http://localhost:8080/doxygen as well, but it may fail with HTTP status 500 and the following error returned as the HTTP response body because memcache seems to not be available in the local dev_appserver environment: service bridge HTTP failed: Post "http://appengine.googleapis.internal:10001/rpc_http": dial tcp: lookup appengine.googleapis.internal: no such host The /doxygen URL can be tested in a verison of the app that’s been deployed before traffic has been migrated to it by visiting the staged deployed version from the App Engine console. To deploy: % version=$(git rev-parse --short=12 HEAD) % [[ -n "$(git status --porcelain)" ]] && version+=-dirty % …/google-cloud-sdk/bin/gcloud app deploy \ --project=crashpad-home --version="${version}" --no-promote \ "$(pwd)/src/crashpad-home" (Note: the $(pwd) is necessary for “gcloud app deploy” to recognize that the application is in GOPATH, putting it into “GOPATH mode”. This normally happens correctly on its own even with a relative path, but will fail for relative paths when $(pwd) is a symbolic link. Using an absolute path here will save you from this frustration, freeing you up to undoubtedly experience other frustrations.) Activate a newly-deployed version by visiting the App Engine console at https://console.cloud.google.com/appengine/versions?project=crashpad-home, selecting it, and choosing “Migrate Traffic”. It is also possible to delete old versions from this page when they are no longer needed.