From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-3.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0E8B1C433B4 for ; Thu, 22 Apr 2021 04:44:05 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id C986861430 for ; Thu, 22 Apr 2021 04:44:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229907AbhDVEoh (ORCPT ); Thu, 22 Apr 2021 00:44:37 -0400 Received: from mav.lukeshu.com ([104.207.138.63]:60414 "EHLO mav.lukeshu.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231468AbhDVEob (ORCPT ); Thu, 22 Apr 2021 00:44:31 -0400 Received: from lukeshu-dw-thinkpad (unknown [IPv6:2601:281:8200:26:4e34:88ff:fe48:5521]) by mav.lukeshu.com (Postfix) with ESMTPSA id 1B10280590; Thu, 22 Apr 2021 00:43:49 -0400 (EDT) Date: Wed, 21 Apr 2021 22:43:48 -0600 Message-ID: <878s5b2akb.wl-lukeshu@lukeshu.com> From: Luke Shumaker To: Eric Sunshine Cc: Luke Shumaker , Git List , Elijah Newren , Junio C Hamano , Jeff King , Johannes Schindelin , =?UTF-8?B?Tmd1eeG7hW4g?= =?ISO-8859-1?Q?Th=E1i_?= =?UTF-8?B?Tmfhu41j?= Duy , Taylor Blau , "brian m . carlson" , Luke Shumaker Subject: Re: [PATCH v2 2/3] fast-export: rename --signed-tags='warn' to 'warn-verbatim' In-Reply-To: References: <20210422002749.2413359-1-lukeshu@lukeshu.com> <20210422002749.2413359-3-lukeshu@lukeshu.com> User-Agent: Wanderlust/2.15.9 (Almost Unreal) SEMI-EPG/1.14.7 (Harue) FLIM-LB/1.14.9 (=?ISO-8859-4?Q?Goj=F2?=) APEL-LB/10.8 EasyPG/1.0.0 Emacs/27.2 (x86_64-pc-linux-gnu) MULE/6.0 (HANACHIRUSATO) MIME-Version: 1.0 (generated by SEMI-EPG 1.14.7 - "Harue") Content-Type: text/plain; charset=US-ASCII Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org On Wed, 21 Apr 2021 21:59:04 -0600, Eric Sunshine wrote: > On Wed, Apr 21, 2021 at 8:34 PM Luke Shumaker 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. Fair enough. My precedent was ee4bc3715f (fast-export: rename the signed tag mode 'ignore' to 'verbatim', 2007-12-03). I guess I'll document --signed-tags=ignore too, while I'm at it. -- Happy hacking, ~ Luke Shumaker