Re: [PATCH] format-patch: allow --rfc to optionally take a value, like --rfc=WIP

From: Jeff King <peff@peff.net>
Date: Apr 19, 2024, 18:00 UTC
Message-ID: <20240419180012.GA523357@coredump.intra.peff.net>
In-Reply-To: <xmqqzftqnuxq.fsf@gitster.g>

On Thu, Apr 18, 2024 at 03:54:25PM -0700, Junio C Hamano wrote:

Show 13 quoted lines

> ---rfc::
> -	Prepends "RFC" to the subject prefix (producing "RFC PATCH" by
> -	default). RFC means "Request For Comments"; use this when sending
> -	an experimental patch for discussion rather than application.
> +--rfc[=<rfc>]::
> +	Prepends the string _<rfc>_ (defaults to "RFC") to
> +	the subject prefix.  As the subject prefix defaults to
> +	"PATCH", you'll get "RFC PATCH" by default.
> ++
> +RFC means "Request For Comments"; use this when sending
> +an experimental patch for discussion rather than application.
> +"--rfc=WIP" may also be a useful way to indicate that a patch
> +is not complete yet.

It's probably worth spelling out WIP here, too, like:

  ...is not complete yet ("WIP" stands for "Work In Progress").

These are necessarily going to be project-specific phrases, and readers of the manpage may not be familiar with our conventions.

-Peff