From 319afa08d4455e1e195497730cce683bb2235461 Mon Sep 17 00:00:00 2001 From: Tim Byrne Date: Mon, 17 Jan 2022 11:14:21 -0600 Subject: [PATCH] Add section on ignoring files (#204) --- _docs/110_faq.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/_docs/110_faq.md b/_docs/110_faq.md index ef3b812..1b9da6a 100644 --- a/_docs/110_faq.md +++ b/_docs/110_faq.md @@ -159,6 +159,27 @@ configuration by running: yadm config yadm.auto-private-dirs false ``` +## Ignoring Files + +### How can I configure ignored files? + +By default, yadm is configured to +[ignore untracked files](#how-can-i-display-untracked-files-with-a-yadm-status-command) +when displaying a status. This does not prevent you from adding untracked files. +However, if you would like to prevent some files from being added accidentally, +you can configure them to be ignored. + +If you add a `.gitignore` file to your `$HOME` directory (or subdirectories) you +can have those patterns ignored by yadm. This works exactly like it does for +Git. Be sure to add these `.gitignore` files to your repo, so they can be synced +along with your other configurations. + +Another option is to add patterns to +`$HOME/.local/share/yadm/repo.git/info/exclude`. +If you use this file, be sure to add your patterns above any +`yadm-auto-excludes` line, as all lines below this can be overwritten by yadm +when encrypting data. + ## Integrations ### Why does git-cola hang when run via `yadm enter`?