On Thu, Jan 14, 2021 at 03:18:48PM +0100, BALATON Zoltan wrote: > On Thu, 14 Jan 2021, Stefan Hajnoczi wrote: > > On Wed, Jan 13, 2021 at 07:20:42PM -0500, John Snow wrote: > > > On 1/13/21 6:45 PM, BALATON Zoltan wrote: > > > > > > > > Please don't. That would break all scripts that already call qemu using > > > > single dash options. Forcing everyone to edit their scripts is not nice. > > > > How about also accepting single dash in qemu-img for consistency then > > > > you can use whatever you want in docs as long as single dash still works > > > > for consistency and backward compatibility. > > > > > > That's not what I meant -- I meant for documentation purposes. QEMU can > > > keep > > > accepting single dash, but we should standardize on the spelling for > > > purposes of interactive messages, documentation, etc. > > > > I wasn't aware of the fact that some of the utilities are sensitive to > > '--' vs '-'! I'm in favor of consistently using '--' in documentation > > but allowing both for backwards compatibility where '-' is currently > > supported. > > > > If we are in agreement, then let's: > > > > 1. Add a section to CODING_STYLE.rst or other developer documentation > > documenting this. > > I'd be more in favour of documenting that QEMU accepts - options but also -- > as alternative and fixing the tools that currently use getopt_long to use > getopt_long_only to keep it consistent with main QEMU executable. Otherwise > this will get more and more inconsistent with new options added with -- and > old ones only exist in - form so to keep consistency we should standardise > on - not --. > > > 2. Convert existing documentation to use '--'. This will make it more > > consistent and also avoid confusion about '-' vs '--'. > > You could still use -- in documentation but what's the problem with - if -- > is also accepted if one wants to type that?
What is the policy for QEMU documentation? 1. Use '-' everywhere or 2. Use '--' everywhere or 3. Use whichever you prefer or ? Stefan
signature.asc
Description: PGP signature
