Skip to content

Commit

Permalink
Change submodule to include slightly different styling, so newly
Browse files Browse the repository at this point in the history
added ToC depth will render nicely.
  • Loading branch information
rafrombrc committed Feb 5, 2015
1 parent 3941a5b commit 845f706
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 37 deletions.
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[submodule "docs/source/_themes/mozilla"]
path = docs/source/_themes/mozilla
url = https://github.com/rafrombrc/mozilla-sphinx-theme.git
branch = heka
38 changes: 3 additions & 35 deletions docs/source/config/inputs/index_noref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,9 @@
Inputs
======

Common Input Parameters
=======================

.. versionadded:: 0.9

There are some configuration options that are universally available to all
Heka input plugins. These will be consumed by Heka itself when Heka
initializes the plugin and do not need to be handled by the plugin-specific
initialization code.

- decoder (string, optional):
Decoder to be used by the input. This should refer to the name of a
registered decoder plugin configuration. If supplied, messages will be
decoded before being passed on to the router when the InputRunner's
`Deliver` method is called.
- synchronous_decode (bool, optional):
If `synchronous_decode` is false, then any specified decoder plugin will
be run by a DecoderRunner in its own goroutine and messages will be passed
in to the decoder over a channel, freeing the input to start processing
the next chunk of incoming or available data. If true, then any decoding
will happen synchronously and message delivery will not return control to
the input until after decoding has completed. Defaults to false.
- send_decode_failures (bool, optional):
If false, then if an attempt to decode a message fails then Heka will log
an error message and then drop the message. If true, then in addition to
logging an error message, decode failure will cause the original,
undecoded message to be tagged with a `decode_failure` field (set to true)
and delivered to the router for possible further processing.
- splitter (string, optional)
Splitter to be used by the input. This should refer to the name of a
registered splitter plugin configuration. It specifies how the input
should split the incoming data stream into individual records prior to
decoding and/or injection to the router. Typically defaults to
"NullSplitter", although certain inputs override this with a different
default value.
.. include:: /config/inputs/index.rst
:start-line: 9
:end-line: 44

.. include:: /config/inputs/amqp.rst
:start-line: 1
Expand Down
2 changes: 1 addition & 1 deletion docs/source/config/inputs/logstreamer.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _config_logstreamer_input:

Log Streamer Input
Logstreamer Input
==================

.. versionadded:: 0.5
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ hekad Command Line Options
Contents:

.. toctree::
:maxdepth: 2
:maxdepth: 3

installing
getting_started
Expand Down

0 comments on commit 845f706

Please sign in to comment.