Browse Source

Sync cli docs

Matt Robenolt 9 years ago
parent
commit
90262289e4

+ 22 - 0
docs/cli/dsym/import-system-symbols/index.rst

@@ -0,0 +1,22 @@
+`sentry dsym import-system-symbols [BUNDLES]...`
+------------------------------------------------
+
+Imports system symbols from preprocessed zip files into Sentry.
+
+It takes a list of zip files as arguments that contain preprocessed
+system symbol information.  These zip files contain JSON dumps.  The
+actual zipped up dsym files cannot be used here, they need to be
+preprocessed.
+
+Options
+```````
+
+- ``--threads INTEGER``: The number of threads to use
+- ``--trim-symbols``: If enabled symbols are trimmed before storing. This
+  reduces the database size but means that symbols are already trimmed on
+  the way to the database.
+- ``--no-demangle``: If this is set to true symbols are never demangled.
+  By default symbols are demangled if they are trimmed or demangled
+  symbols are shorter than mangled ones. Enabling this option speeds up
+  importing slightly.
+- ``--help``: print this help page.

+ 24 - 0
docs/cli/dsym/index.rst

@@ -0,0 +1,24 @@
+`sentry dsym`
+-------------
+
+Manage system symbols in Sentry.
+
+This allows you to import and manage globally shared system symbols in
+the Sentry installation.  In particular this is useful for iOS where
+system symbols need to be ingested before stacktraces can be fully
+symbolized due to device optimizations.
+
+Options
+```````
+
+- ``--help``: print this help page.
+
+Subcommands
+```````````
+
+.. toctree::
+ :maxdepth: 1
+
+ sdks <sdks/index>
+ import-system-symbols <import-system-symbols/index>
+

+ 17 - 0
docs/cli/dsym/sdks/index.rst

@@ -0,0 +1,17 @@
+`sentry dsym sdks`
+------------------
+
+Print a list of all installed SDKs and a breakdown of the symbols
+contained within.  This queries the system symbol database and reports
+all SDKs and versions that symbols exist for.  The output is broken down
+by minor versions, builds and cpu architectures.  For each of those a
+count of the stored bundles is returned.  (A bundle in this case is a
+single binary)
+
+Options
+```````
+
+- ``--sdk TEXT``: Only include the given SDK instead of all.
+- ``--version TEXT``: Optionally a version filter.  For instance 9 returns
+  all versions 9.*, 9.1 returns 9.1.* etc.
+- ``--help``: print this help page.

+ 3 - 0
docs/cli/index.rst.inc

@@ -23,6 +23,7 @@ Subcommands
 
  repair <repair/index>
  upgrade <upgrade/index>
+ run <run/index>
  help <help/index>
  queues <queues/index>
  plugins <plugins/index>
@@ -37,4 +38,6 @@ Subcommands
  import <import/index>
  shell <shell/index>
  config <config/index>
+ tsdb <tsdb/index>
+ dsym <dsym/index>
 

+ 19 - 0
docs/cli/run/index.rst

@@ -0,0 +1,19 @@
+`sentry run`
+------------
+
+Run a service.
+
+Options
+```````
+
+- ``--help``: print this help page.
+
+Subcommands
+```````````
+
+.. toctree::
+ :maxdepth: 1
+
+ web <web/index>
+ smtp <smtp/index>
+

+ 12 - 0
docs/cli/run/smtp/index.rst

@@ -0,0 +1,12 @@
+`sentry run smtp`
+-----------------
+
+Run inbound email service.
+
+Options
+```````
+
+- ``-b, --bind ADDRESS``: Bind address.
+- ``--upgrade``: Upgrade before starting.
+- ``--noinput``: Do not prompt the user for input of any kind.
+- ``--help``: print this help page.

+ 14 - 0
docs/cli/run/web/index.rst

@@ -0,0 +1,14 @@
+`sentry run web`
+----------------
+
+Run web service.
+
+Options
+```````
+
+- ``-b, --bind ADDRESS``: Bind address.
+- ``-w, --workers INTEGER``: The number of worker processes for handling
+  requests.
+- ``--upgrade``: Upgrade before starting.
+- ``--noinput``: Do not prompt the user for input of any kind.
+- ``--help``: print this help page.

+ 1 - 1
docs/cli/start/index.rst

@@ -1,7 +1,7 @@
 `sentry start [SERVICE]`
 ------------------------
 
-Start running a service.
+DEPRECATED see `sentry run` instead.
 
 Options
 ```````

+ 18 - 0
docs/cli/tsdb/index.rst

@@ -0,0 +1,18 @@
+`sentry tsdb`
+-------------
+
+Tools for interacting with the time series database.
+
+Options
+```````
+
+- ``--help``: print this help page.
+
+Subcommands
+```````````
+
+.. toctree::
+ :maxdepth: 1
+
+ query <query/index>
+

+ 18 - 0
docs/cli/tsdb/query/index.rst

@@ -0,0 +1,18 @@
+`sentry tsdb query`
+-------------------
+
+Execute queries against the time series database.
+
+Options
+```````
+
+- ``--help``: print this help page.
+
+Subcommands
+```````````
+
+.. toctree::
+ :maxdepth: 1
+
+ organizations <organizations/index>
+

Some files were not shown because too many files changed in this diff