Improved doc

Project: http://git-wip-us.apache.org/repos/asf/flume/repo
Commit: http://git-wip-us.apache.org/repos/asf/flume/commit/a459732c
Tree: http://git-wip-us.apache.org/repos/asf/flume/tree/a459732c
Diff: http://git-wip-us.apache.org/repos/asf/flume/diff/a459732c

Branch: refs/heads/trunk
Commit: a459732c0bf4af251c2e14189143acaf72bc0d0b
Parents: bd098ce
Author: Juhani Connolly <[email protected]>
Authored: Thu Jul 19 12:22:47 2012 +0900
Committer: Juhani Connolly <[email protected]>
Committed: Thu Jul 19 12:22:47 2012 +0900

----------------------------------------------------------------------
 flume-ng-doc/sphinx/FlumeUserGuide.rst |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flume/blob/a459732c/flume-ng-doc/sphinx/FlumeUserGuide.rst
----------------------------------------------------------------------
diff --git a/flume-ng-doc/sphinx/FlumeUserGuide.rst 
b/flume-ng-doc/sphinx/FlumeUserGuide.rst
index 4877fc5..3d69840 100644
--- a/flume-ng-doc/sphinx/FlumeUserGuide.rst
+++ b/flume-ng-doc/sphinx/FlumeUserGuide.rst
@@ -947,6 +947,10 @@ the file is closed, this extension is removed. This allows 
excluding partially
 complete files in the directory.
 Required properties are in **bold**.
 
+.. note:: For all of the time related escape sequences, a header with the key
+          "timestamp" must exist among the headers of the event. One way to add
+          this automatically is to use the TimestampInterceptor.
+
 ======================  ============  
======================================================================
 Name                    Default       Description
 ======================  ============  
======================================================================

Reply via email to