From cc98f07b099ae70235c1fc36e6c88959a25c65d4 Mon Sep 17 00:00:00 2001 From: Daniel Mitterdorfer Date: Fri, 10 Mar 2017 18:21:45 +0100 Subject: [PATCH] Document document-count for parent-child Closes #155 --- docs/track.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/track.rst b/docs/track.rst index 9d50a9345..f2754eb29 100644 --- a/docs/track.rst +++ b/docs/track.rst @@ -82,7 +82,7 @@ Each type consists of the following properties: * ``name`` (mandatory): Name of the type. * ``mapping`` (mandatory): File name of the corresponding mapping file. -* ``documents`` (optional): File name of the corresponding documents that should be indexed. This file has to be compressed either as bz2, zip or tar.gz and must contain exactly one JSON file with the same name +* ``documents`` (optional): File name of the corresponding documents that should be indexed. If you are using parent-child, specify the number of parent documents. This file has to be compressed either as bz2, zip or tar.gz and must contain exactly one JSON file with the same name. * ``document-count`` (optional): Number of documents in the documents file. This number will be used to verify that all documents have been indexed successfully. * ``compressed-bytes`` (optional): The size in bytes of the compressed document file. This number is used to show users how much data will be downloaded by Rally and also to check whether the download is complete. * ``uncompressed-bytes`` (optional): The size in bytes of the documents file after decompression.