Bläddra i källkod

Merge pull request #7693 from ThomasWaldmann/docs-1.2

docs updates (1.2-maint)
TW 1 år sedan
förälder
incheckning
6b0dc53f11
2 ändrade filer med 67 tillägg och 7 borttagningar
  1. 57 7
      docs/changes.rst
  2. 10 0
      docs/faq.rst

+ 57 - 7
docs/changes.rst

@@ -212,15 +212,13 @@ The best check that everything is ok is to run a dry-run extraction::
 
 
     borg extract -v --dry-run REPO::ARCHIVE
     borg extract -v --dry-run REPO::ARCHIVE
 
 
-.. _changelog:
-
-Change Log
-==========
+.. _upgradenotes:
 
 
-Version 1.2.4 (2023-03-24)
---------------------------
+Upgrade Notes
+=============
 
 
-Upgrade notes:
+borg 1.1.x to 1.2.x
+-------------------
 
 
 Some things can be recommended for the upgrade process from borg 1.1.x
 Some things can be recommended for the upgrade process from borg 1.1.x
 (please also read the important compatibility notes below):
 (please also read the important compatibility notes below):
@@ -296,6 +294,58 @@ Compatibility notes:
   them to check for >= 128.
   them to check for >= 128.
 
 
 
 
+.. _changelog:
+
+Change Log
+==========
+
+Version 1.2.5 (not released yet)
+--------------------------------
+
+For upgrade and compatibility hints, please also read the section "Upgrade Notes"
+above.
+
+Fixes:
+
+- extract: fix false warning about pattern never matching, #4110
+- diff: remove surrogates before output, #7535
+- compact: clear empty directories at end of compact process, #6823
+- create --files-cache=size: fix crash, #7658
+- keyfiles: improve key sanity check, #7561
+- only warn about "invalid" chunker params, #7590
+- ProgressIndicatorPercent: fix space computation for wide chars, #3027
+- improve argparse validator error messages
+
+New features:
+
+- mount: make up volname if not given (macOS), #7690.
+  macFUSE supports a volname mount option to give what finder displays on the
+  desktop / in the directory view. if the user did not specify it, we make
+  something up, because otherwise it would be "macFUSE Volume 0 (Python)" and
+  hide the mountpoint directory name.
+
+Other changes:
+
+- docs:
+
+  - move upgrade notes to own section, see #7546
+  - mount -olocal: how to show mount in finder's sidebar, #5321
+  - list: fix --pattern examples, #7611
+  - improve patterns help
+  - incl./excl. options, path-from-stdin exclusiveness
+  - obfuscation docs: markup fix, note about MAX_DATA_SIZE
+  - --one-file-system: add macOS apfs notes, #4876
+  - improve --one-file-system help string, #5618
+- tests:
+
+  - fix repo reopen
+  - avoid long ids in pytest output
+  - check buzhash chunksize distribution, see #7586
+
+
+Version 1.2.4 (2023-03-24)
+--------------------------
+
 New features:
 New features:
 
 
 - import-tar: add --ignore-zeros to process concatenated tars, #7432.
 - import-tar: add --ignore-zeros to process concatenated tars, #7432.

+ 10 - 0
docs/faq.rst

@@ -1263,6 +1263,16 @@ space.
 Miscellaneous
 Miscellaneous
 #############
 #############
 
 
+macOS: borg mounts not shown in Finder's side bar
+-------------------------------------------------
+
+https://github.com/osxfuse/osxfuse/wiki/Mount-options#local
+
+Read the above first and use this on your own risk::
+
+    borg mount -olocal REPO MOUNTPOINT
+
+
 Requirements for the borg single-file binary, esp. (g)libc?
 Requirements for the borg single-file binary, esp. (g)libc?
 -----------------------------------------------------------
 -----------------------------------------------------------