threads / patch / 56773

patch, 2 partsdoc-diff fixes on maint

Subject: [PATCH 0/2] doc-diff fixes on maint

## tl;dr

3 messages between Oct 24, 2021 and Oct 24, 2021. Diffs are folded; open one to read it.

replies: 2people: 1as markdown or json

Martin Ågren· Oct 24, 2021, 17:08 UTC · lore

Two small patches to address some things I noticed when going through the doc-diff between v2.33.0 and 9d530dc002 ("The fourteenth batch", 2021-10-18).

This is based on maint, since the original commits are already in v2.33.1.

Martin Ågren (2):
  git.txt: fix typo
  git-bundle.txt: add missing words and punctuation
 Documentation/git-bundle.txt | 8 ++++----
 Documentation/git.txt        | 2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)
-- 
2.33.1.711.g9d530dc002
Martin Ågren· Oct 24, 2021, 17:08 UTC · re: Martin Ågren · lore

[PATCH 1/2] git.txt: fix typo

Fix the spelling of "internally".
Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/git.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/git.txt +1 −1
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 95fe6f31b4..6bb06d0b52 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -42,7 +42,7 @@ OPTIONS
 --version::
 	Prints the Git suite version that the 'git' program came from.
 +
-This option is internaly converted to `git version ...` and accepts
+This option is internally converted to `git version ...` and accepts
 the same options as the linkgit:git-version[1] command. If `--help` is
 also given, it takes precedence over `--version`.
 
-- 
2.33.1.711.g9d530dc002
Martin Ågren· Oct 24, 2021, 17:08 UTC · re: Martin Ågren · lore

[PATCH 2/2] git-bundle.txt: add missing words and punctuation

Add an "and" to separate the two halves of the first sentence of the paragraph more. Add a comma to similarly separate the two halves of the second sentence a bit better. Add a period at the end of the paragraph.

Further down in the file, add the missing "be" in "must be accompanied".
Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/git-bundle.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Show changes to Documentation/git-bundle.txt +4 −4
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index ac0d003835..50ea8c82ca 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -51,10 +51,10 @@ using the `--thin` option to linkgit:git-pack-objects[1], and
 unbundled using the `--fix-thin` option to linkgit:git-index-pack[1].
 
 There is no option to create a "thick pack" when using revision
-exclusions, users should not be concerned about the difference. By
-using "thin packs" bundles created using exclusions are smaller in
+exclusions, and users should not be concerned about the difference. By
+using "thin packs", bundles created using exclusions are smaller in
 size. That they're "thin" under the hood is merely noted here as a
-curiosity, and as a reference to other documentation
+curiosity, and as a reference to other documentation.
 
 See link:technical/bundle-format.html[the `bundle-format`
 documentation] for more details and the discussion of "thin pack" in
@@ -144,7 +144,7 @@ unbundle <file>::
 SPECIFYING REFERENCES
 ---------------------
 
-Revisions must accompanied by reference names to be packaged in a
+Revisions must be accompanied by reference names to be packaged in a
 bundle.
 
 More than one reference may be packaged, and more than one set of prerequisite objects can
-- 
2.33.1.711.g9d530dc002

← back to recent threads