Michael Eischer
de55280003
Merge pull request #21809 from MichaelEischer/doc-typos
...
doc: fix typos, unify section heading style and minor additions
2026-05-20 22:32:59 +02:00
Winfried Plappert
990329013e
prune more aggresively ( #21803 )
...
Co-authored-by: Michael Eischer <michael.eischer@fau.de >
2026-05-16 15:49:08 +00:00
Michael Eischer
770ec1e25a
doc: clarify ** usage
2026-05-16 17:01:52 +02:00
Michael Eischer
e212076f71
doc: correctly use RST backticks
...
RST uses double backticks for inline code unlike the single backticks in
Markdown.
2026-05-15 23:37:54 +02:00
Michael Eischer
b16f0bf410
doc: use sentence case for section headings
2026-05-15 23:37:54 +02:00
Michael Eischer
75f92f22d9
doc: unify section headings to gerund phrases
...
Use -ing headings for sections across the user manual.
2026-05-15 23:37:54 +02:00
Michael Eischer
4c9a07e9c8
doc: stick to second-persion "you" in user docs
...
Replace usages of `we`, `one` and "it is possible" with the mainly used `you`.
2026-05-15 23:13:29 +02:00
Michael Eischer
5bc7398e5e
doc: sync S3 path in tutorial with S3 path in reference
...
Regional endpoints should be preferred. Omitting `https://` defaults to
https.
2026-05-15 22:55:22 +02:00
Michael Eischer
07bb05deaa
doc: add RESTIC_FROM_* environment variables to scripting section
2026-05-15 22:45:08 +02:00
Michael Eischer
4b52ef9a97
doc: correct description of forget --tag
2026-05-15 22:44:27 +02:00
Michael Eischer
bd7f3483ac
doc: clarify repository setup for copy
2026-05-15 22:43:09 +02:00
Michael Eischer
f6c8751575
doc: consistency fixes
2026-05-15 22:42:29 +02:00
Michael Eischer
2419c03177
doc: fix several typos
2026-05-15 22:25:51 +02:00
Michael Eischer
b7d8c98214
docs: clarify backup step in troubleshooting guide ( #21802 )
2026-05-15 21:23:48 +02:00
Michael Eischer
8abbc3703d
doc: update embedded help output and misc typos ( #21804 )
2026-05-15 20:21:04 +02:00
JL710
7acab7b1a9
add example for "Pulling a Backup with HTTP over a ssh tunnel" ( #5504 )
...
Co-authored-by: Leo R. Lundgren <leo@finalresort.org >
Co-authored-by: Michael Eischer <michael.eischer@fau.de >
2026-05-14 12:52:33 +00:00
Michael Eischer
5d70bf9f10
Merge pull request #5643 from kjetilho/doc-restore
...
Improve documentation for restore
2026-05-14 14:51:45 +02:00
Michael Eischer
6c63c1c244
partially modernize restore command output
2026-05-14 13:43:54 +02:00
Michael Eischer
acc95531a4
docs/restore: clarify --path option example, subfolder syntax and --delete option
2026-05-14 13:42:33 +02:00
Adrian Mastronardi
9a0432a5d7
docs: clarify double-asterisk wildcard behavior in exclude patterns ( #5726 )
2026-05-13 20:25:36 +00:00
Michael Eischer
f3854cf299
Merge pull request #21796 from restic/go-1.25
...
Bump minimum go version to 1.25 & update dependencies
2026-05-12 18:56:09 +02:00
Michael Eischer
4a63f7fd13
Merge pull request #5701 from jylenhof/master
2026-05-10 21:31:15 +02:00
Michael Eischer
6080c784e4
Bump minimum go version to 1.25
2026-05-10 17:53:08 +02:00
Michael Eischer
ed418d8d60
document that switching between relative and absolute paths prevents change detection
2026-05-10 17:40:55 +02:00
Michael Eischer
93357440da
doc: describe effects of relative paths on snapshot structure
2026-05-10 17:34:42 +02:00
jylenhof
24c3b73f7c
doc(installation): add mise alternative installation method
...
Signed-off-by: jylenhof <jygithub@lenhof.eu.org >
2026-05-08 12:20:18 +02:00
Rohan Santhosh Kumar
90ce78dbaa
docs: fix Nix installation typo ( #21772 )
...
Co-authored-by: Codex <codex@openai.com >
2026-05-07 22:13:20 +02:00
Codex
b1e9811ffc
Fix a typo in the contributing docs
2026-04-01 10:32:50 +08:00
Michael Eischer
271d622823
Merge pull request #5725 from AdrianMastronardi/fix/4258-document-backup-progress-bar
2026-02-26 21:29:29 +01:00
Adrian Mastronardi
9b1d45935a
docs: remove version-specific references from RHEL/CentOS instructions
2026-02-24 01:02:42 +01:00
Adrian Mastronardi
102ea6da2b
docs: document backup progress bar fields ( #4258 )
2026-02-24 00:06:38 +01:00
Adrian Mastronardi
4e71921a17
docs: remove outdated CentOS 6/7 installation instructions ( #5218 )
2026-02-23 23:15:49 +01:00
Winfried Plappert
c5e09ae9b1
docs: expand restic find - documentation ( #5675 )
2026-02-19 18:07:05 +00:00
Winfried Plappert
1f329cd933
docs: expand documentation about testing ( #5346 )
2026-02-19 18:26:15 +01:00
Michael Eischer
4c56384481
docs: describe assigning ambient capabilities using systemd ( #5698 )
...
---
Co-authored-by: udf2457 <udf2457@users.noreply.github.com >
2026-02-18 22:33:21 +01:00
Michael Eischer
27c560b371
Merge pull request #5650 from fabien-joubert/docs-warning-capabilities
...
docs: add warning for capability-based non-root backups
2026-02-18 21:44:04 +01:00
Michael Eischer
d3c225627f
Merge pull request #5682 from wplapper/docs_list
2026-02-01 11:55:37 +01:00
Winfried Plappert
b544e71cac
restic list doc - documenmtation
...
fixed wording for paragraph and inconsistent underlining
2026-02-01 06:12:56 +00:00
Winfried Plappert
099650f883
docs: restic list
...
corrected typo
2026-02-01 06:02:39 +00:00
Winfried Plappert
6154685c3a
docs: add documentation for restic list
...
added a file doc/view_repository.rst which contains the
description of `restic list ...`
2026-02-01 06:02:39 +00:00
Winfried Plappert
5148608c39
restic rewrite include - based on restic 0.18.1
...
cmd/restic/cmd_rewrite.go:
introduction of include filters for this command:
- add include filters, add error checking code
- add new parameter 'keepEmptyDirectoryFunc' to 'walker.NewSnapshotSizeRewriter()',
so empty directories have to be kept to keep the directory structure intact
- add parameter 'keepEmptySnapshot' to 'filterAndReplaceSnapshot()' to keep snapshots
intact when nothing is to be included
- introduce helper function 'gatherIncludeFilters()' and 'gatherExcludeFilters()' to
keep code flow clean
cmd/restic/cmd_rewrite_integration_test.go:
add several new tests around the 'include' functionality
internal/filter/include.go:
this is where is include filter is defined
internal/walker/rewriter.go:
- struct RewriteOpts gains field 'KeepEmtpyDirectory', which is a 'NodeKeepEmptyDirectoryFunc()'
which defaults to nil, so that al subdirectories are kept
- function 'NewSnapshotSizeRewriter()' gains the parameter 'keepEmptyDirecoryFilter' which
controls the management of empty subdirectories in case of include filters active
internal/data/tree.go:
gains a function Count() for checking the number if node elements in a newly built tree
internal/walker/rewriter_test.go:
function 'NewSnapshotSizeRewriter()' gets an additional parameter nil to keeps things happy
cmd/restic/cmd_repair_snapshots.go:
function 'filterAndReplaceSnapshot()' gets an additional parameter 'keepEmptySnapshot=nil'
doc/045_working_with_repos.rst:
gets to mention include filters
changelog/unreleased/issue-4278:
the usual announcement file
git rebase master -i produced this
restic rewrite include - keep linter happy
cmd/restic/cmd_rewrite_integration_test.go:
linter likes strings.Contain() better than my strings.Index() >= 0
2026-01-31 19:42:56 +00:00
Michael Eischer
34fdf5ba96
Merge pull request #5636 from MichaelEischer/clarify-parameter-docs
2026-01-31 19:15:24 +01:00
Michael Eischer
4bc6bb7e27
slightly reduce redundant wording
2026-01-31 19:07:06 +01:00
fabien-joubert
8179c4f676
docs: add warning for capability-based non-root backups
2025-12-27 22:38:16 +01:00
Kjetil Torgrim Homme
ee099e4662
doc: restore: simplify restore target name
...
the suffix "-work" is visually distracting since it copies a part of the
directory path being restored. this makes it easy to gloss over where
the "work" string actually comes from. as a bonus, it makes the examples
slightly shorter to read.
2025-12-05 18:07:11 +01:00
Kjetil Torgrim Homme
655e527765
doc: restore: be clearer about resulting filenames in restore
2025-12-05 18:04:46 +01:00
Kjetil Torgrim Homme
d34ba9b6bd
doc: restore: explain how --delete and --exclude work together
2025-12-05 17:59:56 +01:00
Kjetil Torgrim Homme
0673b58d7c
doc: restore: explain explicitly effect of specifying snapshot:subfolder
...
The effect could be read from the examples, but it was easy to miss.
2025-12-05 17:50:53 +01:00
Michael Eischer
4fd9bfc32b
docs: fix table width
2025-12-03 20:38:21 +01:00
Michael Eischer
7a3b06f78a
docs: move environment variables to the scripting section
2025-12-03 18:38:36 +01:00