{"thread":{"id":"57809","subject":"[PATCH] Documentation: replace - use consistent 'replace reference'","startedAt":"2022-04-27T20:31:06Z","lastAt":"2022-04-27T21:01:35Z","messageCount":2,"participants":["Yaroslav Halchenko","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"454541","messageId":"20220427195450.366703-1-debian@onerussian.com","threadId":"57809","inReplyTo":null,"subject":"[PATCH] Documentation: replace - use consistent 'replace reference'","fromName":"Yaroslav Halchenko","fromEmail":"debian@onerussian.com","sentAt":"2022-04-27T19:54:50Z","receivedAt":"2022-04-27T20:31:06Z","isPatch":true,"sender":{"key":"debian@onerussian.com","avatar":"https://gravatar.com/avatar/9d2f005048a0274a9c26bc47a51f580e2bf631dfedfdb18370f65e08e4250317?d=mp&s=160"},"body":"As a new user to 'git replace' I found it a little uncertain about what\n\"'replace' reference\" documentation was talking since there was only\n\"replacement\" mentioned in the command summary.  Decided to make it more\nconsistent as 'replace reference' after checking that in a few spots there is a\nuse of multi word entries within <>.\n\nSigned-off-by: Yaroslav Halchenko <debian@onerussian.com>\n---\n Documentation/git-replace.txt | 10 +++++-----\n 1 file changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt\nindex f271d758c3..71f98edfe3 100644\n--- a/Documentation/git-replace.txt\n+++ b/Documentation/git-replace.txt\n@@ -8,7 +8,7 @@ git-replace - Create, list, delete refs to replace objects\n SYNOPSIS\n --------\n [verse]\n-'git replace' [-f] <object> <replacement>\n+'git replace' [-f] <object> <replace reference>\n 'git replace' [-f] --edit <object>\n 'git replace' [-f] --graft <commit> [<parent>...]\n 'git replace' [-f] --convert-graft-file\n@@ -17,16 +17,16 @@ SYNOPSIS\n \n DESCRIPTION\n -----------\n-Adds a 'replace' reference in `refs/replace/` namespace.\n+Adds a 'replace reference' in `refs/replace/` namespace.\n \n-The name of the 'replace' reference is the SHA-1 of the object that is\n-replaced. The content of the 'replace' reference is the SHA-1 of the\n+The name of the 'replace reference' is the SHA-1 of the object that is\n+replaced. The content of the 'replace reference' is the SHA-1 of the\n replacement object.\n \n The replaced object and the replacement object must be of the same type.\n This restriction can be bypassed using `-f`.\n \n-Unless `-f` is given, the 'replace' reference must not yet exist.\n+Unless `-f` is given, the 'replace reference' must not yet exist.\n \n There is no other restriction on the replaced and replacement objects.\n Merge commits can be replaced by non-merge commits and vice versa.\n-- \n2.35.1\n\n"},{"id":"454548","messageId":"xmqq8rrqkzqe.fsf@gitster.g","threadId":"57809","inReplyTo":"20220427195450.366703-1-debian@onerussian.com","subject":"Re: [PATCH] Documentation: replace - use consistent 'replace reference'","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2022-04-27T21:01:13Z","receivedAt":"2022-04-27T21:01:35Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Yaroslav Halchenko <debian@onerussian.com> writes:\n\n> As a new user to 'git replace' I found it a little uncertain about what\n> \"'replace' reference\" documentation was talking since there was only\n> \"replacement\" mentioned in the command summary.  Decided to make it more\n> consistent as 'replace reference' after checking that in a few spots there is a\n> use of multi word entries within <>.\n>\n> Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>\n> ---\n>  Documentation/git-replace.txt | 10 +++++-----\n>  1 file changed, 5 insertions(+), 5 deletions(-)\n>\n> diff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt\n> index f271d758c3..71f98edfe3 100644\n> --- a/Documentation/git-replace.txt\n> +++ b/Documentation/git-replace.txt\n> @@ -8,7 +8,7 @@ git-replace - Create, list, delete refs to replace objects\n>  SYNOPSIS\n>  --------\n>  [verse]\n> -'git replace' [-f] <object> <replacement>\n> +'git replace' [-f] <object> <replace reference>\n\nIf we must use a multi-word, perhaps come up with a dashed form to\nmake it still a single token, i.e.\n\n\t'git replace' [-f] <object> <replace-reference>\n\notherwise it forces people to first think \"ah, command reads from a\nfile (whose name can be 'replace'), and then...\" and then backtrack\nbecause the \"reference>\" part would not be syntactically correct.\n\nYou earlier mentioned that you copied the pattern from elsewhere.\nThese places may have to be updated, too.\n\n\n>  'git replace' [-f] --edit <object>\n>  'git replace' [-f] --graft <commit> [<parent>...]\n>  'git replace' [-f] --convert-graft-file\n> @@ -17,16 +17,16 @@ SYNOPSIS\n>  \n>  DESCRIPTION\n>  -----------\n> -Adds a 'replace' reference in `refs/replace/` namespace.\n> +Adds a 'replace reference' in `refs/replace/` namespace.\n\nAnd this part becomes 'replace-reference', too.\n\nIf we must invent and use such a new multi-word jargon, it probably\nis a good idea to define it in Documentation/glossary-content.txt\n\nOther than that, looking good.\n\nThanks.\n"}]}