summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason Butz <jason.butz@genesys.com>2017-08-25 07:16:21 -0400
committerScott Moser <smoser@ubuntu.com>2017-08-25 14:39:06 -0700
commit44773a480d8fe32e97da44afd01e5882a480d136 (patch)
treeda82bf377071947c657fee75508725e34ffdfea6
parentf831a874021f3d6d24cbe5639a176f416b5436a6 (diff)
downloadvyos-cloud-init-44773a480d8fe32e97da44afd01e5882a480d136.tar.gz
vyos-cloud-init-44773a480d8fe32e97da44afd01e5882a480d136.zip
doc: Explain error behavior in user data include file format.
Update user data 'include file' format documentation to explain the behavior that occurs when an error occurs while reading a file.
-rw-r--r--doc/rtd/topics/format.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/rtd/topics/format.rst b/doc/rtd/topics/format.rst
index 436eb00f..e25289ad 100644
--- a/doc/rtd/topics/format.rst
+++ b/doc/rtd/topics/format.rst
@@ -85,6 +85,7 @@ This content is a ``include`` file.
The file contains a list of urls, one per line.
Each of the URLs will be read, and their content will be passed through this same set of rules.
Ie, the content read from the URL can be gzipped, mime-multi-part, or plain text.
+If an error occurs reading a file the remaining files will not be read.
Begins with: ``#include`` or ``Content-Type: text/x-include-url`` when using a MIME archive.