From: Eric Sunshine <firstname.lastname@example.org> To: Luke Shumaker <email@example.com> Cc: "Git List" <firstname.lastname@example.org>, "Elijah Newren" <email@example.com>, "Junio C Hamano" <firstname.lastname@example.org>, "Jeff King" <email@example.com>, "Johannes Schindelin" <Johannes.Schindelin@gmx.de>, "Nguyễn Thái Ngọc Duy" <firstname.lastname@example.org>, "Taylor Blau" <email@example.com>, "brian m . carlson" <firstname.lastname@example.org>, "Luke Shumaker" <email@example.com> Subject: Re: [PATCH v2 2/3] fast-export: rename --signed-tags='warn' to 'warn-verbatim' Date: Wed, 21 Apr 2021 23:59:04 -0400 [thread overview] Message-ID: <CAPig+cRk_0sevG6iVbCdMPKV7XRwkrCAvEC_YRGvPkxwZoXUuw@mail.gmail.com> (raw) In-Reply-To: <firstname.lastname@example.org> On Wed, Apr 21, 2021 at 8:34 PM Luke Shumaker <email@example.com> wrote: > The --signed-tags= option takes one of five arguments specifying how to > handle signed tags during export. Among these arguments, 'strip' is to > 'warn-strip' as 'verbatim' is to 'warn' (the unmentioned argument is > 'abort', which stops the fast-export process entirely). That is, > signatures are either stripped or copied verbatim while exporting, with > or without a warning. > > Match the pattern and rename 'warn' to 'warn-verbatim' to make it clear > that it instructs fast-export to copy signatures verbatim. > > To maintain backwards compatibility, 'warn' is still recognized as > an undocumented alias. Maintaining backward compatibility is good; making it undocumented is perhaps less than good. I understand the motivation for not wanting to document it: if it's not documented, people won't discover it, thus won't use it. However, we also should take into consideration that there may be scripts and documentation in the wild which use `warn`. If someone comes across one of those and wants to learn what it means, they won't be able to if the documentation doesn't mention it at all; they'll either have to consult the source code to find out its purpose or post a question somewhere, hoping that someone knows the answer. So, rather than removing it from the documentation altogether, it's probably better to mention that it is a deprecated alias of `warn-verbatim`. As precedent, for instance, see the `dimmed-zebra` option in Documentation/diff-options.txt which still mentions its `dimmed_zebra` synonym: dimmed-zebra:: Similar to 'zebra', but additional dimming of uninteresting parts of moved code is performed. The bordering lines of two adjacent blocks are considered interesting, the rest is uninteresting. `dimmed_zebra` is a deprecated synonym. > Signed-off-by: Luke Shumaker <firstname.lastname@example.org> > --- > diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt > @@ -27,7 +27,7 @@ OPTIONS > ---signed-tags=(verbatim|warn|warn-strip|strip|abort):: > +--signed-tags=(verbatim|warn-verbatim|warn-strip|strip|abort):: > @@ -36,8 +36,8 @@ When asking to 'abort' (which is the default), this program will die > -exported and with 'warn', they will be exported, but you will see a > -warning. > +exported and with 'warn-verbatim', they will be exported, but you will > +see a warning. So, perhaps this could end with: `warn` is a deprecated synonym of `warn-verbatim`.
next prev parent reply other threads:[~2021-04-22 3:59 UTC|newest] Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-04-22 0:27 [PATCH v2 0/3] fast-export, fast-import: implement signed-commits Luke Shumaker 2021-04-22 0:27 ` [PATCH v2 1/3] git-fast-import.txt: add missing LF in the BNF Luke Shumaker 2021-04-22 0:27 ` [PATCH v2 2/3] fast-export: rename --signed-tags='warn' to 'warn-verbatim' Luke Shumaker 2021-04-22 3:59 ` Eric Sunshine [this message] 2021-04-22 4:43 ` Luke Shumaker 2021-04-22 4:50 ` Luke Shumaker 2021-04-22 0:27 ` [PATCH v2 3/3] fast-export, fast-import: implement signed-commits Luke Shumaker 2021-04-23 16:41 ` [PATCH v3 0/3] " Luke Shumaker 2021-04-23 16:41 ` [PATCH v3 1/3] git-fast-import.txt: add missing LF in the BNF Luke Shumaker 2021-04-23 16:41 ` [PATCH v3 2/3] fast-export: rename --signed-tags='warn' to 'warn-verbatim' Luke Shumaker 2021-04-28 3:29 ` Junio C Hamano 2021-04-29 19:02 ` Luke Shumaker 2021-04-30 0:03 ` Junio C Hamano 2021-04-23 16:41 ` [PATCH v3 3/3] fast-export, fast-import: implement signed-commits Luke Shumaker 2021-04-28 4:02 ` Junio C Hamano 2021-04-29 20:06 ` Luke Shumaker 2021-04-29 22:38 ` Elijah Newren 2021-04-29 23:42 ` Junio C Hamano 2021-04-30 2:23 ` Elijah Newren 2021-04-30 3:20 ` Junio C Hamano 2021-04-30 17:07 ` Luke Shumaker 2021-04-30 19:34 ` Luke Shumaker 2021-04-30 19:59 ` Elijah Newren 2021-04-30 22:21 ` Luke Shumaker 2021-04-30 23:25 ` [PATCH v4 0/5] fast-export, fast-import: add support for signed-commits Luke Shumaker 2021-04-30 23:25 ` [PATCH v4 1/5] git-fast-import.txt: add missing LF in the BNF Luke Shumaker 2021-04-30 23:25 ` [PATCH v4 2/5] fast-export: rename --signed-tags='warn' to 'warn-verbatim' Luke Shumaker 2021-04-30 23:25 ` [PATCH v4 3/5] git-fast-export.txt: clarify why 'verbatim' may not be a good idea Luke Shumaker 2021-04-30 23:25 ` [PATCH v4 4/5] fast-export: do not modify memory from get_commit_buffer Luke Shumaker 2021-05-03 4:41 ` Junio C Hamano 2021-04-30 23:25 ` [PATCH v4 5/5] fast-export, fast-import: add support for signed-commits Luke Shumaker 2021-05-03 5:09 ` Junio C Hamano
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style List information: http://vger.kernel.org/majordomo-info.html * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=CAPig+cRk_0sevG6iVbCdMPKV7XRwkrCAvEC_YRGvPkxwZoXUuw@mail.gmail.com \ --email@example.com \ --cc=Johannes.Schindelin@gmx.de \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --subject='Re: [PATCH v2 2/3] fast-export: rename --signed-tags='\''warn'\'' to '\''warn-verbatim'\''' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Code repositories for project(s) associated with this inbox: https://80x24.org/mirrors/git.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).