docs: clarify requirements when using command line options with special characters within a shell

[goebbe]

Clarify docs:
Within a shell, command line options with special characters require adjustments, such as quotation marks.
#8578

[goebbe]

Some check were not successful - but I don't understand the underlying issue.
I hope this is not caused by this pull request.

[ThomasWaldmann]

Thanks for the PR!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.82%. Comparing base (1559a1e) to head (1cb9c19).
Report is 14 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #8628      +/-   ##
==========================================
- Coverage   81.83%   81.82%   -0.02%     
==========================================
  Files          74       74              
  Lines       13319    13348      +29     
  Branches     1963     1971       +8     
==========================================
+ Hits        10900    10922      +22     
- Misses       1755     1761       +6     
- Partials      664      665       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ThomasWaldmann]

LGTM.

[ThomasWaldmann]

Thanks!

[ThomasWaldmann]

maybe we want a backport of this to 1.4.

[goebbe]

maybe we want a backport of this to 1.4.

In GitHub, if I switch to branch 1.4-maint I can not find the file src/borg/archiver/help_cmd.py
Actually, using the file GitHub file search, I could not even find a file named help_cmd.py in this branch.
Where can I find the internal docs for 1.4.?

This could be me, doing something stupid/ not understanding some fundamental principles of git/ GitHub.
Any advice or hint is welcome.

[goebbe]

I think I found the corresponding file with the help text in branch 1.4.:
borg/src/borg/archiver.py
line 2310: helptext['patterns'] = textwrap.dedent('''

Sorry for the noise - I will send a pull request for branch 1.4.

[ThomasWaldmann]

@goebbe the file structure between 1.x and master is a bit different.

in 1.x, we had a huge archiver.py file with code for all commands inside. that was split into an archiver package with 1 file per command / per few related commands.