On Mon, Nov 07, 2022 at 06:22:34PM +0100, Ævar Arnfjörð Bjarmason wrote: > > On Mon, Nov 07 2022, Eric Sunshine wrote: > > > On Mon, Nov 7, 2022 at 9:56 AM Ævar Arnfjörð Bjarmason <avarab@xxxxxxxxx> wrote: > >> On Mon, Nov 07 2022, Teng Long wrote: > >> > When appending to a given object which has note and if the appended > >> > note is not empty too, we will insert a blank line at first. The > >> > blank line serves as a split line, but sometimes we just want to > >> > omit it then append on the heels of the target note. So, we add > >> > a new "OPT_BOOL()" option to determain whether a new blank line > >> > is insert at first. > >> > > >> > Signed-off-by: Teng Long <dyroneteng@xxxxxxxxx> > >> > --- > >> > diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt > >> > @@ -159,6 +161,11 @@ OPTIONS > >> > +--blank-line:: > >> > +--no-blank-line:: > >> > + Controls if a blank line to split paragraphs is inserted > >> > + when appending (the default is true). > >> > >> Just make this: > >> > >> --no-blank-line: > >> Suppress the insertion of a blank line before the > >> inserted notes. > >> > >> Or something, i.e. when adding a "true by default" let's add a "no-..." variant directly. > > > > This is the exact opposite of Junio's advice[1], isn't it? > > > > [1]: https://lore.kernel.org/git/xmqqsfjsi7eq.fsf@gitster.g/ > > I read that as him mainly talking about what we name the variable (which > I agree with, but didn't comment on here). I'm talking about what > interface is exposed to the user. Having --blank-line as an option is convenient for scripting, so I'd err on the side of the original interpretation of Junio's suggestion. We can clearly support '--[no-]blank-line' and allow latter arguments to override previous ones. The documentation is fine as-is. Thanks, Taylor
