diff mbox series

[03/12] qga: Replace '--blacklist' command line option by '--denylist'

Message ID 20210202205824.1085853-4-philmd@redhat.com (mailing list archive)
State New, archived
Headers show
Series misc: Replace the words 'blacklist/whitelist' | expand

Commit Message

Philippe Mathieu-Daudé Feb. 2, 2021, 8:58 p.m. UTC
Follow the inclusive terminology from the "Conscious Language in your
Open Source Projects" guidelines [*] and replace the word "blacklist"
appropriately.

Keep the --blacklist available for backward compatibility.

[*] https://github.com/conscious-lang/conscious-lang-docs/blob/main/faq.md

Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
---
 docs/interop/qemu-ga.rst | 2 +-
 qga/main.c               | 6 ++++--
 2 files changed, 5 insertions(+), 3 deletions(-)

Comments

Daniel P. Berrangé Feb. 3, 2021, 10:09 a.m. UTC | #1
On Tue, Feb 02, 2021 at 09:58:15PM +0100, Philippe Mathieu-Daudé wrote:
> Follow the inclusive terminology from the "Conscious Language in your
> Open Source Projects" guidelines [*] and replace the word "blacklist"
> appropriately.
> 
> Keep the --blacklist available for backward compatibility.
> 
> [*] https://github.com/conscious-lang/conscious-lang-docs/blob/main/faq.md
> 
> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> ---
>  docs/interop/qemu-ga.rst | 2 +-
>  qga/main.c               | 6 ++++--
>  2 files changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/interop/qemu-ga.rst b/docs/interop/qemu-ga.rst
> index 9a590bf95cb..89596e646de 100644
> --- a/docs/interop/qemu-ga.rst
> +++ b/docs/interop/qemu-ga.rst
> @@ -79,7 +79,7 @@ Options
>  
>    Daemonize after startup (detach from terminal).
>  
> -.. option:: -b, --blacklist=LIST
> +.. option:: -b, --denylist=LIST
>  
>    Comma-separated list of RPCs to disable (no spaces, ``?`` to list
>    available RPCs).
> diff --git a/qga/main.c b/qga/main.c
> index 249fe06e8e5..66177b9e93d 100644
> --- a/qga/main.c
> +++ b/qga/main.c
> @@ -257,7 +257,8 @@ QEMU_COPYRIGHT "\n"
>  #ifdef _WIN32
>  "  -s, --service     service commands: install, uninstall, vss-install, vss-uninstall\n"
>  #endif
> -"  -b, --blacklist   comma-separated list of RPCs to disable (no spaces, \"?\"\n"
> +"  --blacklist       backward compatible alias for --denylist (deprecated)\n"
> +"  -b, --denylist    comma-separated list of RPCs to disable (no spaces, \"?\"\n"


"-b" is a bit odd as a short name now, but i guess that's not the end
of the world.

The deprecation should be documented though. Ideally we would report
a warning if the deprecated long arg was used too.

>  "                    to list available RPCs)\n"
>  "  -D, --dump-conf   dump a qemu-ga config file based on current config\n"
>  "                    options / command-line parameters to stdout\n"
> @@ -1111,7 +1112,8 @@ static void config_parse(GAConfig *config, int argc, char **argv)
>          { "method", 1, NULL, 'm' },
>          { "path", 1, NULL, 'p' },
>          { "daemonize", 0, NULL, 'd' },
> -        { "blacklist", 1, NULL, 'b' },
> +        { "denylist", 1, NULL, 'b' },
> +        { "blacklist", 1, NULL, 'b' }, /* deprecated alias for 'denylist' */
>  #ifdef _WIN32
>          { "service", 1, NULL, 's' },
>  #endif
> -- 
> 2.26.2
> 
> 

Regards,
Daniel
BALATON Zoltan Feb. 3, 2021, 12:45 p.m. UTC | #2
On Wed, 3 Feb 2021, Daniel P. Berrangé wrote:
> On Tue, Feb 02, 2021 at 09:58:15PM +0100, Philippe Mathieu-Daudé wrote:
>> Follow the inclusive terminology from the "Conscious Language in your
>> Open Source Projects" guidelines [*] and replace the word "blacklist"
>> appropriately.
>>
>> Keep the --blacklist available for backward compatibility.
>>
>> [*] https://github.com/conscious-lang/conscious-lang-docs/blob/main/faq.md
>>
>> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
>> ---
>>  docs/interop/qemu-ga.rst | 2 +-
>>  qga/main.c               | 6 ++++--
>>  2 files changed, 5 insertions(+), 3 deletions(-)
>>
>> diff --git a/docs/interop/qemu-ga.rst b/docs/interop/qemu-ga.rst
>> index 9a590bf95cb..89596e646de 100644
>> --- a/docs/interop/qemu-ga.rst
>> +++ b/docs/interop/qemu-ga.rst
>> @@ -79,7 +79,7 @@ Options
>>
>>    Daemonize after startup (detach from terminal).
>>
>> -.. option:: -b, --blacklist=LIST
>> +.. option:: -b, --denylist=LIST
>>
>>    Comma-separated list of RPCs to disable (no spaces, ``?`` to list
>>    available RPCs).
>> diff --git a/qga/main.c b/qga/main.c
>> index 249fe06e8e5..66177b9e93d 100644
>> --- a/qga/main.c
>> +++ b/qga/main.c
>> @@ -257,7 +257,8 @@ QEMU_COPYRIGHT "\n"
>>  #ifdef _WIN32
>>  "  -s, --service     service commands: install, uninstall, vss-install, vss-uninstall\n"
>>  #endif
>> -"  -b, --blacklist   comma-separated list of RPCs to disable (no spaces, \"?\"\n"
>> +"  --blacklist       backward compatible alias for --denylist (deprecated)\n"
>> +"  -b, --denylist    comma-separated list of RPCs to disable (no spaces, \"?\"\n"
>
>
> "-b" is a bit odd as a short name now, but i guess that's not the end
> of the world.

Maybe -b, --block  or --block-rpc? Not the best but at least preserves 
consistency with the short option.

Regards,
BALATON Zoltan

> The deprecation should be documented though. Ideally we would report
> a warning if the deprecated long arg was used too.
>
>>  "                    to list available RPCs)\n"
>>  "  -D, --dump-conf   dump a qemu-ga config file based on current config\n"
>>  "                    options / command-line parameters to stdout\n"
>> @@ -1111,7 +1112,8 @@ static void config_parse(GAConfig *config, int argc, char **argv)
>>          { "method", 1, NULL, 'm' },
>>          { "path", 1, NULL, 'p' },
>>          { "daemonize", 0, NULL, 'd' },
>> -        { "blacklist", 1, NULL, 'b' },
>> +        { "denylist", 1, NULL, 'b' },
>> +        { "blacklist", 1, NULL, 'b' }, /* deprecated alias for 'denylist' */
>>  #ifdef _WIN32
>>          { "service", 1, NULL, 's' },
>>  #endif
>> --
>> 2.26.2
>>
>>
>
> Regards,
> Daniel
>
Kevin Wolf Feb. 3, 2021, 3:47 p.m. UTC | #3
Am 03.02.2021 um 13:45 hat BALATON Zoltan geschrieben:
> On Wed, 3 Feb 2021, Daniel P. Berrangé wrote:
> > On Tue, Feb 02, 2021 at 09:58:15PM +0100, Philippe Mathieu-Daudé wrote:
> > > Follow the inclusive terminology from the "Conscious Language in your
> > > Open Source Projects" guidelines [*] and replace the word "blacklist"
> > > appropriately.
> > > 
> > > Keep the --blacklist available for backward compatibility.
> > > 
> > > [*] https://github.com/conscious-lang/conscious-lang-docs/blob/main/faq.md
> > > 
> > > Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> > > ---
> > >  docs/interop/qemu-ga.rst | 2 +-
> > >  qga/main.c               | 6 ++++--
> > >  2 files changed, 5 insertions(+), 3 deletions(-)
> > > 
> > > diff --git a/docs/interop/qemu-ga.rst b/docs/interop/qemu-ga.rst
> > > index 9a590bf95cb..89596e646de 100644
> > > --- a/docs/interop/qemu-ga.rst
> > > +++ b/docs/interop/qemu-ga.rst
> > > @@ -79,7 +79,7 @@ Options
> > > 
> > >    Daemonize after startup (detach from terminal).
> > > 
> > > -.. option:: -b, --blacklist=LIST
> > > +.. option:: -b, --denylist=LIST
> > > 
> > >    Comma-separated list of RPCs to disable (no spaces, ``?`` to list
> > >    available RPCs).
> > > diff --git a/qga/main.c b/qga/main.c
> > > index 249fe06e8e5..66177b9e93d 100644
> > > --- a/qga/main.c
> > > +++ b/qga/main.c
> > > @@ -257,7 +257,8 @@ QEMU_COPYRIGHT "\n"
> > >  #ifdef _WIN32
> > >  "  -s, --service     service commands: install, uninstall, vss-install, vss-uninstall\n"
> > >  #endif
> > > -"  -b, --blacklist   comma-separated list of RPCs to disable (no spaces, \"?\"\n"
> > > +"  --blacklist       backward compatible alias for --denylist (deprecated)\n"
> > > +"  -b, --denylist    comma-separated list of RPCs to disable (no spaces, \"?\"\n"
> > 
> > 
> > "-b" is a bit odd as a short name now, but i guess that's not the end
> > of the world.
> 
> Maybe -b, --block  or --block-rpc? Not the best but at least preserves
> consistency with the short option.

I was thinking about something like --blocked-rpcs, too, so +1 from me
for your latter option.

If we're touching these names, let's try to actually make them good, not
just different. Neither --blacklist nor --denylist actually describe
well what the option does.

Kevin
Michael Roth Feb. 3, 2021, 4:02 p.m. UTC | #4
On Wed, Feb 03, 2021 at 04:47:08PM +0100, Kevin Wolf wrote:
> Am 03.02.2021 um 13:45 hat BALATON Zoltan geschrieben:
> > On Wed, 3 Feb 2021, Daniel P. Berrangé wrote:
> > > On Tue, Feb 02, 2021 at 09:58:15PM +0100, Philippe Mathieu-Daudé wrote:
> > > > Follow the inclusive terminology from the "Conscious Language in your
> > > > Open Source Projects" guidelines [*] and replace the word "blacklist"
> > > > appropriately.
> > > > 
> > > > Keep the --blacklist available for backward compatibility.
> > > > 
> > > > [*] https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fconscious-lang%2Fconscious-lang-docs%2Fblob%2Fmain%2Ffaq.md&amp;data=04%7C01%7Cmichael.roth%40amd.com%7Cd17bb9d899914df4e04108d8c85b068f%7C3dd8961fe4884e608e11a82d994e183d%7C0%7C0%7C637479640585250068%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&amp;sdata=HM%2Fg%2B79VIjp%2BR9bIVBDPkYHHbFa9C3sGMvhomxhJdgE%3D&amp;reserved=0
> > > > 
> > > > Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> > > > ---
> > > >  docs/interop/qemu-ga.rst | 2 +-
> > > >  qga/main.c               | 6 ++++--
> > > >  2 files changed, 5 insertions(+), 3 deletions(-)
> > > > 
> > > > diff --git a/docs/interop/qemu-ga.rst b/docs/interop/qemu-ga.rst
> > > > index 9a590bf95cb..89596e646de 100644
> > > > --- a/docs/interop/qemu-ga.rst
> > > > +++ b/docs/interop/qemu-ga.rst
> > > > @@ -79,7 +79,7 @@ Options
> > > > 
> > > >    Daemonize after startup (detach from terminal).
> > > > 
> > > > -.. option:: -b, --blacklist=LIST
> > > > +.. option:: -b, --denylist=LIST
> > > > 
> > > >    Comma-separated list of RPCs to disable (no spaces, ``?`` to list
> > > >    available RPCs).
> > > > diff --git a/qga/main.c b/qga/main.c
> > > > index 249fe06e8e5..66177b9e93d 100644
> > > > --- a/qga/main.c
> > > > +++ b/qga/main.c
> > > > @@ -257,7 +257,8 @@ QEMU_COPYRIGHT "\n"
> > > >  #ifdef _WIN32
> > > >  "  -s, --service     service commands: install, uninstall, vss-install, vss-uninstall\n"
> > > >  #endif
> > > > -"  -b, --blacklist   comma-separated list of RPCs to disable (no spaces, \"?\"\n"
> > > > +"  --blacklist       backward compatible alias for --denylist (deprecated)\n"
> > > > +"  -b, --denylist    comma-separated list of RPCs to disable (no spaces, \"?\"\n"
> > > 
> > > 
> > > "-b" is a bit odd as a short name now, but i guess that's not the end
> > > of the world.
> > 
> > Maybe -b, --block  or --block-rpc? Not the best but at least preserves
> > consistency with the short option.
> 
> I was thinking about something like --blocked-rpcs, too, so +1 from me
> for your latter option.
> 
> If we're touching these names, let's try to actually make them good, not
> just different. Neither --blacklist nor --denylist actually describe
> well what the option does.

+1 on --blocked-rpcs

> 
> Kevin
>
diff mbox series

Patch

diff --git a/docs/interop/qemu-ga.rst b/docs/interop/qemu-ga.rst
index 9a590bf95cb..89596e646de 100644
--- a/docs/interop/qemu-ga.rst
+++ b/docs/interop/qemu-ga.rst
@@ -79,7 +79,7 @@  Options
 
   Daemonize after startup (detach from terminal).
 
-.. option:: -b, --blacklist=LIST
+.. option:: -b, --denylist=LIST
 
   Comma-separated list of RPCs to disable (no spaces, ``?`` to list
   available RPCs).
diff --git a/qga/main.c b/qga/main.c
index 249fe06e8e5..66177b9e93d 100644
--- a/qga/main.c
+++ b/qga/main.c
@@ -257,7 +257,8 @@  QEMU_COPYRIGHT "\n"
 #ifdef _WIN32
 "  -s, --service     service commands: install, uninstall, vss-install, vss-uninstall\n"
 #endif
-"  -b, --blacklist   comma-separated list of RPCs to disable (no spaces, \"?\"\n"
+"  --blacklist       backward compatible alias for --denylist (deprecated)\n"
+"  -b, --denylist    comma-separated list of RPCs to disable (no spaces, \"?\"\n"
 "                    to list available RPCs)\n"
 "  -D, --dump-conf   dump a qemu-ga config file based on current config\n"
 "                    options / command-line parameters to stdout\n"
@@ -1111,7 +1112,8 @@  static void config_parse(GAConfig *config, int argc, char **argv)
         { "method", 1, NULL, 'm' },
         { "path", 1, NULL, 'p' },
         { "daemonize", 0, NULL, 'd' },
-        { "blacklist", 1, NULL, 'b' },
+        { "denylist", 1, NULL, 'b' },
+        { "blacklist", 1, NULL, 'b' }, /* deprecated alias for 'denylist' */
 #ifdef _WIN32
         { "service", 1, NULL, 's' },
 #endif