From c29ba8d72224b545cbd7cf9446c3ed2ef13f8c24 Mon Sep 17 00:00:00 2001 From: Anish Athalye Date: Sun, 26 Mar 2017 11:30:36 -0400 Subject: [PATCH] Add documentation on force option for clean plugin --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 468c59c..80748d8 100644 --- a/README.md +++ b/README.md @@ -273,16 +273,26 @@ command itself. Clean commands specify directories that should be checked for dead symbolic links. These dead links are removed automatically. Only dead links that point -to the dotfiles directory are removed. +to the dotfiles directory are removed unless the `force` option is set to +`true`. #### Format Clean commands are specified as an array of directories to be cleaned. +Clean commands support an extended configuration syntax. In this type of +configuration, commands are specified as directory paths mapping to options. If +the `force` option is set to `true`, dead links are removed even if they don't +point to a file inside the dotfiles directory. + #### Example ```yaml - clean: ['~'] + +- clean: + ~/.config: + force: true ``` ### Defaults