https://bugs.kde.org/show_bug.cgi?id=515720

            Bug ID: 515720
           Summary: Link to patterns is unspecific
    Classification: Applications
           Product: kbackup
      Version First 25.12.2
       Reported In:
          Platform: Other
                OS: Linux
            Status: REPORTED
          Severity: normal
          Priority: NOR
         Component: general
          Assignee: [email protected]
          Reporter: [email protected]
  Target Milestone: ---

In THE KCM Configure>Advanced, there is a line "Patterns need to be listed in a
text file with one pattern per line. Files and folders with names that match
any of the patterns will be excluded from the backup. The pattern format is
documented in the bup-index manual page"

It is here in the code:

https://invent.kde.org/system/kup/-/blob/master/kcm/backupplanwidget.cpp?ref_type=heads#L923

It would much more handy if the link went straight to "--exclude-rx=pattern" in
the corresponging man page. I thought I would make a PR but I have no idea how
to link to a subpage in khelpcenter from C++. As the page basically just
directs to Python docs,  it might actually read:

"Patterns need to be listed in a text file with one pattern per line without
leading or trailing quotes. Files and folders with names that match any of the
patterns will be excluded from the backup. Patterns are Python regular
expressions. For details, see the bup-index manual page or Python
documentation*"

* link to https://www.w3schools.com/python/python_regex.asp

This would specify the pattern is Python regex, also link directly to them and
specify no quotes are needed, as both the man page and Python docs are using
them and it is a bit unclear (at least to me) how exactly they should be
entered.

An alternative could be
"Patterns need to be listed in a text file with one pattern per line. Files and
folders with names that match any of the patterns will be excluded from the
backup. Patterns are Python regular expressions, so for example to exclude any
file named “foo”, use the following line: “/foo$” (without the quotes). For
details, see the bup-index manual page or Python documentation*"

-- 
You are receiving this mail because:
You are watching all bug changes.

Reply via email to