From 34f05d4ba649d16bf0e3d94b160838635dd48dc1 Mon Sep 17 00:00:00 2001 From: Justin Mayer Date: Thu, 2 May 2013 17:18:19 -0700 Subject: [PATCH] Add warning to docs re: DELETE_OUTPUT_DIRECTORY --- docs/settings.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/settings.rst b/docs/settings.rst index 9ff9c8e3..3a32ad22 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -64,8 +64,10 @@ Setting name (default value) What doe ``'(?P\d{4}-\d{2}-\d{2})_(?P.*)'``. `PATH_METADATA` (``''``) Like ``FILENAME_METADATA``, but parsed from a page's full path relative to the content source directory. -`DELETE_OUTPUT_DIRECTORY` (``False``) Delete the content of the output directory before - generating new files. +`DELETE_OUTPUT_DIRECTORY` (``False``) Delete the output directory, and **all** of its contents, before + generating new files. This can be useful in preventing older, + unnecessary files from persisting in your output. However, **this is + a destructive setting and should be handled with extreme care.** `FILES_TO_COPY` (``()``) A list of files (or directories) to copy from the source (inside the content directory) to the destination (inside the output directory). For example: ``(('extra/robots.txt', 'robots.txt'),)``.