mirror of
https://github.com/chromium/crashpad.git
synced 2024-12-27 07:14:10 +08:00
acabe35928
This makes Doxygen’s output more actionable by setting QUIET = YES to suppress verbose progress spew, and WARN_IF_UNDOCUMENTED = NO to prevent warnings for undocumented classes and members from being generated. The latter is too noisy, producing 721 warnings in the current codebase. The remaining warnings produced by Doxygen were useful and actionable. They fell into two categories: abuses of Doxygen’s markup syntax, and missing (or misspelled) parameter documentation. In a small number of cases, pass-through parameters had intentionally been left undocumented. In these cases, they are now given blank \param descriptions. This is not optimal, but there doesn’t appear to be any other way to tell Doxygen to allow a single parameter to be undocumented. Some tricky Doxygen errors were resolved by asking it to not enter directiores that we do not provide documentation in (such as the “on-platform” compat directories, compat/mac and compat/win, as well as compat/non_cxx11_lib) while allowing it to enter the “off-platform” directories that we do document (compat/non_mac and compat/non_win). A Doxygen run (doc/support/generate_doxygen.sh) now produces no output at all. It would produce warnings if any were triggered. Not directly related, but still relevant to documentation, doc/support/generate.sh is updated to remove temporary removals of now-extinct files and directories. doc/appengine/README is updated so that a consistent path to “goapp” is used throughout the file. Change-Id: I300730c04de4d3340551ea3086ca70cc5ff862d1 Reviewed-on: https://chromium-review.googlesource.com/408812 Reviewed-by: Robert Sesek <rsesek@chromium.org>
40 lines
1.6 KiB
Plaintext
40 lines
1.6 KiB
Plaintext
This is the App Engine app that serves https://crashpad.chromium.org/.
|
|
|
|
To work on this app, obtain the App Engine SDK for Go from
|
|
https://cloud.google.com/appengine/docs/go/download. Unpacking it produces a
|
|
go_appengine directory. This may be added to your $PATH for convenience,
|
|
although it is not necessary.
|
|
|
|
The commands in this README are expected to be run from the directory containing
|
|
app.yaml.
|
|
|
|
The App Engine SDK for Go provides App Engine packages at the “appengine” import
|
|
path, but not the newer “google.golang.org/appengine” path. The Crashpad app
|
|
uses the newer paths. See
|
|
https://github.com/golang/appengine#2-update-import-paths and
|
|
https://code.google.com/p/googleappengine/issues/detail?id=11670. To make these
|
|
available, obtain a Go release from https://golang.org/dl/, and run:
|
|
|
|
$ GOROOT=…/go_appengine/goroot GOPATH=…/go_appengine/gopath go get -d
|
|
|
|
To test locally:
|
|
|
|
$ …/go_appengine/goapp serve
|
|
|
|
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.
|
|
|
|
To deploy:
|
|
|
|
$ version=$(git rev-parse --short=12 HEAD)
|
|
$ [[ -n "$(git status --porcelain)" ]] && version+=-dirty
|
|
$ …/go_appengine/goapp deploy -version "${version}"
|
|
|
|
Note that app.yaml does not name a “version” to encourage you to use a git hash
|
|
as the version, as above.
|
|
|
|
Activate a newly-deployed version by visiting the App Engine console at
|
|
https://appengine.google.com/deployment?&app_id=s~crashpad-home, selecting it,
|
|
and choosing “Make Default”. It is also possible to delete old versions from
|
|
this page when they are no longer needed.
|