Skip to content

Commit

Permalink
Add note about config file location and update screen shot
Browse files Browse the repository at this point in the history
  • Loading branch information
rdswift authored and phw committed Sep 29, 2021
1 parent bc1b906 commit b628354
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 20 deletions.
Binary file modified config/images/options-maintenance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 30 additions & 20 deletions config/options_maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,33 @@
.. image:: images/options-maintenance.png
:width: 100 %

Over the course of trying out plugins and such, the configuration INI file can become
bloated with orphaned settings. This section allows you to remove unused option settings
from the configuration INI file.

Settings that are found in the configuration file that do not appear on any option
settings page will be listed. If your configuration file does not contain any unused
option settings, then the list will be empty and the removal checkbox will be
disabled.

To remove one or more settings, first enable the removal by checking the "Remove
selected options" box. You can then select the settings to remove by checking the
box next to the setting. When you choose :guilabel:`Make It So!` to save your option
settings, the selected items will be removed.

.. note::

Unused option settings could come from plugins that have been uninstalled,
so please be careful to not remove settings that you may want to use later when
the plugin is reinstalled. Options belonging to plugins that are installed but
currently disabled will not be listed for possible removal.
**Configuration File**

This displays the path and file name of the configuration INI file currently used by
Picard. This file contains all of your settings and preferences, and the format of the
file is consistent across operating systems. There is also a :guilabel:`Open Folder`
button to open the location in your system's file browser, so that you can easily make
a backup copy of the file or to copy the settings for use on a different computer.

**Configuration File Cleanup**

Over the course of trying out plugins and such, the configuration INI file can become
bloated with orphaned settings. This section allows you to remove unused option settings
from the configuration INI file.

Settings that are found in the configuration file that do not appear on any option
settings page will be listed. If your configuration file does not contain any unused
option settings, then the list will be empty and the removal checkbox will be
disabled.

To remove one or more settings, first enable the removal by checking the "Remove
selected options" box. You can then select the settings to remove by checking the
box next to the setting. When you choose :guilabel:`Make It So!` to save your option
settings, the selected items will be removed.

.. note::

Unused option settings could come from plugins that have been uninstalled,
so please be careful to not remove settings that you may want to use later when
the plugin is reinstalled. Options belonging to plugins that are installed but
currently disabled will not be listed for possible removal.

0 comments on commit b628354

Please sign in to comment.