docs: clarify upgrade to Full backup on FileSet changes

docs/manuals/source/Configuration/Director.rst

@@ -40,7 +40,8 @@ The |dir| knows about following resource types:
 Director Resource
 -----------------
 
-:index:`\ <single: Director Resource>`\  :index:`\ <single: Resource; Director>`\ 
+.. index::
+   pair: Director; Resource
 
 The Director resource defines the attributes of the Directors running on the network. Only a single Director resource is allowed.
 
@@ -62,16 +63,16 @@ The following is an example of a valid Director resource definition:
 
 .. include:: /include/autogenerated/bareos-dir-resource-director-description.rst.inc
 
+
 .. _DirectorResourceJob:
 
+.. _JobResource:
+
 Job Resource
 ------------
 
-
-
-.. _JobResource:
-
- :index:`\ <single: Resource; Job>`\  :index:`\ <single: Job; Resource>`\ 
+.. index::
+   pair: Resource; Job
 
 The Job resource defines a Job (Backup, Restore, ...) that Bareos must perform. Each Job resource definition contains the name of a Client and a FileSet to backup, the Schedule for the Job, where the data are to be stored, and what media Pool can be used. In effect, each Job resource must specify What, Where, How, and When or FileSet, Storage, Backup/Restore/Level, and Schedule respectively. Note, the FileSet must be specified for a restore job for historical reasons, but it is no longer used.
 
@@ -215,27 +216,40 @@ w03/w05.
      Run = w02/w02 at 23:10
    }
 
+
 Technical Notes on Schedules
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-:index:`\ <single: Schedule; Technical Notes on Schedules>`\ 
+.. index:: Schedule; Technical Notes
 
 Internally Bareos keeps a schedule as a bit mask. There are six masks and a minute field to each schedule. The masks are hour, day of the month (mday), month, day of the week (wday), week of the month (wom), and week of the year (woy). The schedule is initialized to have the bits of each of these masks set, which means that at the beginning of every hour, the job will run. When you specify a month for the first time, the mask will be cleared and the bit corresponding to your selected month will
 be selected. If you specify a second month, the bit corresponding to it will also be added to the mask. Thus when Bareos checks the masks to see if the bits are set corresponding to the current time, your job will run only in the two months you have set. Likewise, if you set a time (hour), the hour mask will be cleared, and the hour you specify will be set in the bit mask and the minutes will be stored in the minute field.
 
 For any schedule you have defined, you can see how these bits are set by doing a show schedules command in the Console program. Please note that the bit mask is zero based, and Sunday is the first day of the week (bit zero).
 
+
 .. _DirectorResourceFileSet:
 
 FileSet Resource
 ----------------
 
-:index:`\ <single: Resource; FileSet>`
-:index:`\ <single: FileSet; Resource>`
+.. index::
+   pair: Resource; FileSet
 
 The FileSet resource defines what files are to be included or excluded in a backup job. A FileSet resource is required for each backup Job. It consists of a list of files or directories to be included, a list of files or directories to be excluded and the various backup options such as compression, encryption, and signatures that are to be applied to each file.
 
-Any change to the list of the included files will cause Bareos to automatically create a new FileSet (defined by the name and an MD5 checksum of the Include/Exclude contents). Each time a new FileSet is created, Bareos will ensure that the next backup is always a Full save.
+Any change to the list of the included files
+will cause Bareos to automatically create a new FileSet
+(defined by the name and an MD5 checksum of the Include/Exclude File directives contents).
+Each time a new FileSet is created
+Bareos will ensure that the next backup is always a full backup.
+However, this does only apply to changes in directives
+:config:option:`dir/FileSet/Include/File` and
+:config:option:`dir/FileSet/Exclude/File`.
+Changes in other directives or the :ref:`fileset-options` do not result
+in upgrade to a full backup.
+Use :config:option:`dir/FileSet/IgnoreFileSetChanges` to disable this behavior.
+
 
 .. include:: /include/autogenerated/bareos-dir-resource-fileset-table.rst.inc
 
@@ -2140,4 +2154,3 @@ The Counter Resource defines a counter variable that can be accessed by variable
 .. include:: /include/autogenerated/bareos-dir-resource-counter-table.rst.inc
 
 .. include:: /include/autogenerated/bareos-dir-resource-counter-description.rst.inc
-

docs/manuals/source/manually_added_config_directive_descriptions/dir-fileset-IgnoreFileSetChanges.rst.inc

@@ -1,6 +1,10 @@
-Normally, if you modify the FileSet Include or Exclude lists, the next backup will be forced to a Full so that Bareos can guarantee that any additions or deletions are properly saved.
+Normally, if you modify
+:config:option:`dir/FileSet/Include/File` or
+:config:option:`dir/FileSet/Exclude/File`
+of the FileSet Include or Exclude lists,
+the next backup will be forced to a full
+so that Bareos can guarantee that any additions or deletions are properly saved.
 
 We strongly recommend against setting this directive to yes, since doing so may cause you to have an incomplete set of backups.
 
 If this directive is set to :strong:`yes`, any changes you make to the FileSet Include or Exclude lists, will not force a Full during subsequent backups.
-