Skip to contentSkip to conversation

docs: improvements for Git v2.45 changelog

PATCH In review Patrick Steinhardt 2 participants 4 messages Apr 22, 2024 Documentation

lore
Share & tools
lore
#0 lore raw

cover docs: improvements for Git v2.45 changelog

Hi,

this short series contains some small improvements for the Git v2.45 changelog.

Patrick

Patrick Steinhardt (2):
docs: improve changelog entry for git pack-refs --auto
docs: address typos in Git v2.45 changelog

 Documentation/RelNotes/2.45.0.txt | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)
Signature · 1 line
2.45.0-rc0
#1 lore raw

PATCH 1/2 docs: improve changelog entry for `git pack-refs --auto`

The changelog entry for the new git pack-refs --auto mode only says that the new flag is useful, but doesn't really say what it does. Add some more information.

---
 Documentation/RelNotes/2.45.0.txt | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
Documentation/RelNotes/2.45.0.txt +4 -2
index 0570dcd877..0fc29bc3ad 100644
@@ -77,8 +77,10 @@ UI, Workflows & Features
    skip showing the hunk immediately after it has already been shown, and
    an additional action to explicitly ask to reshow the current hunk.
 
- * "git pack-refs" learned the "--auto" option, which is a useful
-   addition to be triggered from "git gc --auto".
+ * "git pack-refs" learned the "--auto" option, which defers the decision of
+   whether and how to pack to the ref backend. This is used by the reftable
+   backend to avoid repacking of an already-optimal ref database. The new mode
+   is triggered from "git gc --auto".
 
  * "git add -u <pathspec>" and "git commit [-i] <pathspec>" did not
    diagnose a pathspec element that did not match any files in certain
Signature · 1 line
2.45.0-rc0
#2 lore raw

PATCH 2/2 docs: address typos in Git v2.45 changelog

In reply to Patrick Steinhardt

Address some typos in the Git v2.45 changelog.

---
 Documentation/RelNotes/2.45.0.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/RelNotes/2.45.0.txt +4 -4
index 0fc29bc3ad..d4c9e9d93f 100644
@@ -250,7 +250,7 @@ Fixes since v2.44
    This has been corrected.
    (merge 199f44cb2e ps/remote-helper-repo-initialization-fix later to maint).
 
- * Various parts of upload-pack has been updated to bound the resource
+ * Various parts of upload-pack have been updated to bound the resource
    consumption relative to the size of the repository to protect from
    abusive clients.
    (merge 6cd05e768b jk/upload-pack-bounded-resources later to maint).
@@ -297,11 +297,11 @@ Fixes since v2.44
    variable that is no longer used.
    (merge 72a8d3f027 pw/rebase-i-ignore-cherry-pick-help-environment later to maint).
 
- * The code to find the effective end of log message can fall into an
+ * The code to find the effective end of log messages can fall into an
    endless loop, which has been corrected.
    (merge 2541cba2d6 fs/find-end-of-log-message-fix later to maint).
 
- * Mark-ups used in the documentation has been improved for
+ * Mark-up used in the documentation has been improved for
    consistency.
    (merge 45d5ed3e50 ja/doc-markup-fixes later to maint).
 
@@ -395,7 +395,7 @@ Fixes since v2.44
    configuration variable used to leak, which has been corrected.
    (merge 0e0fefb29f jc/unleak-core-excludesfile later to maint).
 
- * vreportf(), which is usede by error() and friends, has been taught
+ * vreportf(), which is used by error() and friends, has been taught
    to give the error message printf-format string when its vsnprintf()
    call fails, instead of showing nothing useful to identify the
    nature of the error.
Signature · 1 line
2.45.0-rc0