threads / patch / 52163

patch, 2 partsRelNotes/2.24.0: typofix

Subject: [PATCH 1/2] RelNotes/2.24.0: typofix

## tl;dr

7 messages between Oct 30, 2019 and Nov 2, 2019. Diffs are folded; open one to read it.

replies: 6people: 3as markdown or json

Elijah Newren via GitGitGadget· Oct 30, 2019, 20:21 UTC · lore

[PATCH 0/2] 2.24 release note fixups

A couple minor fixes to the 2.24 release notes. I split into two trivial commits just in case folks don't like the second (perhaps some wording about no current plans to remove filter-branch were intended?)

Elijah Newren (2):
  RelNotes/2.24.0: typofix
  RelNotes/2.24.0: fix self-contradictory note

 Documentation/RelNotes/2.24.0.txt | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

base-commit: f21f8f5d35b09ecdd1a0112f114436fd2eda7df2
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-440%2Fnewren%2F2.24-release-note-fixups-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-440/newren/2.24-release-note-fixups-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/440

-- 
gitgitgadget

Elijah Newren via GitGitGadget· Oct 30, 2019, 20:21 UTC · re: Elijah Newren via GitGitGadget · lore

From: Elijah Newren <newren@gmail.com>

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 Documentation/RelNotes/2.24.0.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to Documentation/RelNotes/2.24.0.txt +1 −1

diff --git a/Documentation/RelNotes/2.24.0.txt b/Documentation/RelNotes/2.24.0.txt
index b7083cd6b2..26e018078d 100644
--- a/Documentation/RelNotes/2.24.0.txt
+++ b/Documentation/RelNotes/2.24.0.txt
@@ -316,7 +316,7 @@ Fixes since v2.23
    to access the worktree correctly, which has been corrected.
    (merge dfd557c978 js/stash-apply-in-secondary-worktree later to maint).
 
- * The merge-recursive machiery is one of the most complex parts of
+ * The merge-recursive machinery is one of the most complex parts of
    the system that accumulated cruft over time.  This large series
    cleans up the implementation quite a bit.
    (merge b657047719 en/merge-recursive-cleanup later to maint).

-- 
gitgitgadget

Taylor Blau· Nov 2, 2019, 03:28 UTC · re: Elijah Newren via GitGitGadget · lore

Re: [PATCH 1/2] RelNotes/2.24.0: typofix

Hi Elijah,

On Wed, Oct 30, 2019 at 08:21:17PM +0000, Elijah Newren via GitGitGadget wrote:

Show 22 quoted lines

> From: Elijah Newren <newren@gmail.com>
>
> Signed-off-by: Elijah Newren <newren@gmail.com>
> ---
>  Documentation/RelNotes/2.24.0.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/RelNotes/2.24.0.txt b/Documentation/RelNotes/2.24.0.txt
> index b7083cd6b2..26e018078d 100644
> --- a/Documentation/RelNotes/2.24.0.txt
> +++ b/Documentation/RelNotes/2.24.0.txt
> @@ -316,7 +316,7 @@ Fixes since v2.23
>     to access the worktree correctly, which has been corrected.
>     (merge dfd557c978 js/stash-apply-in-secondary-worktree later to maint).
>
> - * The merge-recursive machiery is one of the most complex parts of
> + * The merge-recursive machinery is one of the most complex parts of
>     the system that accumulated cruft over time.  This large series
>     cleans up the implementation quite a bit.
>     (merge b657047719 en/merge-recursive-cleanup later to maint).
> --
> gitgitgadget

Thanks, I hadn't noticed this when I read through the release notes myself. This looks obviously good to me.

Thanks, Taylor

Junio C Hamano· Nov 2, 2019, 05:43 UTC · re: Elijah Newren via GitGitGadget · lore

Re: [PATCH 1/2] RelNotes/2.24.0: typofix

"Elijah Newren via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 20 quoted lines

> From: Elijah Newren <newren@gmail.com>
>
> Signed-off-by: Elijah Newren <newren@gmail.com>
> ---
>  Documentation/RelNotes/2.24.0.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/RelNotes/2.24.0.txt b/Documentation/RelNotes/2.24.0.txt
> index b7083cd6b2..26e018078d 100644
> --- a/Documentation/RelNotes/2.24.0.txt
> +++ b/Documentation/RelNotes/2.24.0.txt
> @@ -316,7 +316,7 @@ Fixes since v2.23
>     to access the worktree correctly, which has been corrected.
>     (merge dfd557c978 js/stash-apply-in-secondary-worktree later to maint).
>  
> - * The merge-recursive machiery is one of the most complex parts of
> + * The merge-recursive machinery is one of the most complex parts of
>     the system that accumulated cruft over time.  This large series
>     cleans up the implementation quite a bit.
>     (merge b657047719 en/merge-recursive-cleanup later to maint).

Thanks.

Elijah Newren via GitGitGadget· Oct 30, 2019, 20:21 UTC · re: Elijah Newren via GitGitGadget · lore

[PATCH 2/2] RelNotes/2.24.0: fix self-contradictory note

From: Elijah Newren <newren@gmail.com>

As per Wikipedia, "In current technical usage, for one to state that a feature is deprecated is merely a recommendation against using it." It is thus contradictory to claim that something is not "officially deprecated" and then to immediately state that we are both discouraging its use and pointing people elsewhere.

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 Documentation/RelNotes/2.24.0.txt | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

Show changes to Documentation/RelNotes/2.24.0.txt +3 −4

diff --git a/Documentation/RelNotes/2.24.0.txt b/Documentation/RelNotes/2.24.0.txt
index 26e018078d..bde154124c 100644
--- a/Documentation/RelNotes/2.24.0.txt
+++ b/Documentation/RelNotes/2.24.0.txt
@@ -6,10 +6,9 @@ Updates since v2.23
 
 Backward compatibility note
 
- * Although it is not officially deprecated, "filter-branch" is
-   showing its age and alternatives are available.  From this release,
-   we started to discourage its uses and hint people about
-   filter-repo.
+ * "filter-branch" is showing its age and alternatives are available.
+   From this release, we started to discourage its use and hint
+   people about filter-repo.
 
 UI, Workflows & Features

-- 
gitgitgadget

Taylor Blau· Nov 2, 2019, 03:32 UTC · re: Elijah Newren via GitGitGadget · lore

Re: [PATCH 2/2] RelNotes/2.24.0: fix self-contradictory note

On Wed, Oct 30, 2019 at 08:21:18PM +0000, Elijah Newren via GitGitGadget wrote:

Show 28 quoted lines

> From: Elijah Newren <newren@gmail.com>
>
> As per Wikipedia, "In current technical usage, for one to state that a
> feature is deprecated is merely a recommendation against using it."  It
> is thus contradictory to claim that something is not "officially
> deprecated" and then to immediately state that we are both discouraging
> its use and pointing people elsewhere.
>
> Signed-off-by: Elijah Newren <newren@gmail.com>
> ---
>  Documentation/RelNotes/2.24.0.txt | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/RelNotes/2.24.0.txt b/Documentation/RelNotes/2.24.0.txt
> index 26e018078d..bde154124c 100644
> --- a/Documentation/RelNotes/2.24.0.txt
> +++ b/Documentation/RelNotes/2.24.0.txt
> @@ -6,10 +6,9 @@ Updates since v2.23
>
>  Backward compatibility note
>
> - * Although it is not officially deprecated, "filter-branch" is
> -   showing its age and alternatives are available.  From this release,
> -   we started to discourage its uses and hint people about
> -   filter-repo.
> + * "filter-branch" is showing its age and alternatives are available.
> +   From this release, we started to discourage its use and hint
> +   people about filter-repo.

I suspect that this change was motivated by our off-list correspondence, where I struggled to phrase a section about this in GitHub's release highlights.

I think that I'm mostly reflecting what Elijah has already said himself in another thread, but this change makes sense to me. I think that we have effectively deprecated 'git-filter-branch'. If we're printing warnings when it is called, and recommended that users refer to 'git-filter-repo' instead, I think that we might as well call it deprecated.

But, if that phrase is too heavy-handed for 2.24, I think that this patch makes a lot of sense. It's--as Elijah notes--confusing to say that we recommend against using a tool but haven't 'officially' deprecated it. This works nicely around that issue by not using the phrase 'deprecated' at all, and instead being clear about what the state of 'git filter-branch' is.

>  UI, Workflows & Features
>
> --
> gitgitgadget

Looks good to me.

Thanks, Taylor

Junio C Hamano· Nov 2, 2019, 06:18 UTC · re: Taylor Blau · lore

Re: [PATCH 2/2] RelNotes/2.24.0: fix self-contradictory note

Taylor Blau <me@ttaylorr.com> writes:

Show 5 quoted lines

> ... It's--as Elijah notes--confusing to say that
> we recommend against using a tool but haven't 'officially' deprecated
> it. This works nicely around that issue by not using the phrase
> 'deprecated' at all, and instead being clear about what the state of
> 'git filter-branch' is.

Sounds sensible.  Thanks, both.