Re: [PATCH] tools: rename intel_bios_reader to intel_vbt_decode

[Jani Nikula <jani.nikula@intel.com>]

On Mon, 30 Jan 2017, Ville Syrjälä <ville.syrjala@linux.intel.com> wrote:
> On Mon, Jan 30, 2017 at 10:00:54AM +0200, Jani Nikula wrote:
>> On Tue, 24 Jan 2017, Jani Nikula <jani.nikula@intel.com> wrote:
>> > After all these years intel_bios_reader and intel_bios_dumper still
>> > manage to confuse me. Read or dump, which one decodes. Rename
>> > intel_bios_reader to intel_vbt_decode to be in line with the naming of
>> > all the other tools (particularly the closely related
>> > intel_opregion_decode tool) that decode previously gathered or dumped
>> > information.
>> >
>> > Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>> 
>> Pushed patches 1-5 because they were trivial and I don't expect anyone
>> to care.
>> 
>> How about this one? I don't dare push without acks on the change.
>
> You're not alone in your confusion. I routinely end up trying to use
> the wrong tool. So I for one welcome this change.
>
> Acked-by: Ville Syrjälä <ville.syrjala@linux.intel.com>

Thanks, pushed with that and Petri's IRC ack.

BR,
Jani.

>
>> 
>> BR,
>> Jani.
>> 
>> >
>> > ---
>> >
>> > Patch 6/6 with -M option.
>> > ---
>> >  man/Makefile.am                                     |  4 ++--
>> >  man/intel_bios_dumper.rst                           |  2 +-
>> >  man/{intel_bios_reader.rst => intel_vbt_decode.rst} | 10 +++++-----
>> >  tools/.gitignore                                    |  2 +-
>> >  tools/Makefile.sources                              |  6 +++---
>> >  tools/intel_opregion_decode.c                       |  2 +-
>> >  tools/{intel_bios_reader.c => intel_vbt_decode.c}   |  0
>> >  7 files changed, 13 insertions(+), 13 deletions(-)
>> >  rename man/{intel_bios_reader.rst => intel_vbt_decode.rst} (89%)
>> >  rename tools/{intel_bios_reader.c => intel_vbt_decode.c} (100%)
>> >
>> > diff --git a/man/Makefile.am b/man/Makefile.am
>> > index e40e2e931ada..0098fa45a618 100644
>> > --- a/man/Makefile.am
>> > +++ b/man/Makefile.am
>> > @@ -3,7 +3,6 @@ appman_RST = 				\
>> >  	intel_aubdump.rst		\
>> >  	intel_audio_dump.rst		\
>> >  	intel_bios_dumper.rst		\
>> > -	intel_bios_reader.rst		\
>> >  	intel_error_decode.rst		\
>> >  	intel_gpu_frequency.rst		\
>> >  	intel_gpu_top.rst		\
>> > @@ -16,7 +15,8 @@ appman_RST = 				\
>> >  	intel_upload_blit_large.rst	\
>> >  	intel_upload_blit_large_gtt.rst \
>> >  	intel_upload_blit_large_map.rst \
>> > -	intel_upload_blit_small.rst
>> > +	intel_upload_blit_small.rst	\
>> > +	intel_vbt_decode.rst
>> >  
>> >  if HAVE_RST2MAN
>> >  appman_DATA = $(appman_RST:rst=$(APP_MAN_SUFFIX))
>> > diff --git a/man/intel_bios_dumper.rst b/man/intel_bios_dumper.rst
>> > index 89e0001a70f7..b271b9b1afef 100644
>> > --- a/man/intel_bios_dumper.rst
>> > +++ b/man/intel_bios_dumper.rst
>> > @@ -33,4 +33,4 @@ Report bugs to https://bugs.freedesktop.org.
>> >  SEE ALSO
>> >  ========
>> >  
>> > -**intel_bios_reader(1)**
>> > +**intel_vbt_decode(1)**
>> > diff --git a/man/intel_bios_reader.rst b/man/intel_vbt_decode.rst
>> > similarity index 89%
>> > rename from man/intel_bios_reader.rst
>> > rename to man/intel_vbt_decode.rst
>> > index 0e935904bcfb..a8d36d500b6d 100644
>> > --- a/man/intel_bios_reader.rst
>> > +++ b/man/intel_vbt_decode.rst
>> > @@ -1,6 +1,6 @@
>> > -=================
>> > -intel_bios_reader
>> > -=================
>> > +================
>> > +intel_vbt_decode
>> > +================
>> >  
>> >  -----------------------------
>> >  Intel Video BIOS Table parser
>> > @@ -16,12 +16,12 @@ Intel Video BIOS Table parser
>> >  SYNOPSIS
>> >  ========
>> >  
>> > -**intel_bios_reader** [*OPTIONS*]
>> > +**intel_vbt_decode** [*OPTIONS*]
>> >  
>> >  DESCRIPTION
>> >  ===========
>> >  
>> > -**intel_bios_reader** is a tool to parse the Intel Video BIOS Tables (VBT) and
>> > +**intel_vbt_decode** is a tool to parse the Intel Video BIOS Tables (VBT) and
>> >  present the information in a human readable format.
>> >  
>> >  The preferred ways of getting the binary VBT to parse are:
>> > diff --git a/tools/.gitignore b/tools/.gitignore
>> > index 13825a3c9a74..7f5de26f1d07 100644
>> > --- a/tools/.gitignore
>> > +++ b/tools/.gitignore
>> > @@ -5,7 +5,7 @@ intel_aubdump
>> >  intel_audio_dump
>> >  intel_backlight
>> >  intel_bios_dumper
>> > -intel_bios_reader
>> > +intel_vbt_decode
>> >  intel_display_crc
>> >  intel_display_poller
>> >  intel_dump_decode
>> > diff --git a/tools/Makefile.sources b/tools/Makefile.sources
>> > index e2451ea1272c..2c41afffea39 100644
>> > --- a/tools/Makefile.sources
>> > +++ b/tools/Makefile.sources
>> > @@ -10,7 +10,6 @@ tools_prog_lists =		\
>> >  	intel_reg		\
>> >  	intel_backlight		\
>> >  	intel_bios_dumper	\
>> > -	intel_bios_reader	\
>> >  	intel_display_crc	\
>> >  	intel_display_poller	\
>> >  	intel_forcewaked	\
>> > @@ -28,6 +27,7 @@ tools_prog_lists =		\
>> >  	intel_reg_checker	\
>> >  	intel_residency		\
>> >  	intel_stepping		\
>> > +	intel_vbt_decode	\
>> >  	intel_watermark		\
>> >  	intel_gem_info		\
>> >  	$(NULL)
>> > @@ -47,8 +47,8 @@ intel_reg_SOURCES =		\
>> >  	intel_reg_spec.c	\
>> >  	intel_reg_spec.h
>> >  
>> > -intel_bios_reader_SOURCES =	\
>> > -	intel_bios_reader.c	\
>> > +intel_vbt_decode_SOURCES =	\
>> > +	intel_vbt_decode.c	\
>> >  	intel_bios.h
>> >  
>> >  intel_l3_parity_SOURCES =	\
>> > diff --git a/tools/intel_opregion_decode.c b/tools/intel_opregion_decode.c
>> > index c65828ae2900..f532c1e2952b 100644
>> > --- a/tools/intel_opregion_decode.c
>> > +++ b/tools/intel_opregion_decode.c
>> > @@ -327,7 +327,7 @@ static void decode_vbt(const void *buffer)
>> >  	printf("\tproduct string:\t%s\n", s);
>> >  	free(s);
>> >  
>> > -	printf("\t(use intel_bios_reader to decode the VBT)\n");
>> > +	printf("\t(use intel_vbt_decode to decode the VBT)\n");
>> >  
>> >  	printf("\n");
>> >  }
>> > diff --git a/tools/intel_bios_reader.c b/tools/intel_vbt_decode.c
>> > similarity index 100%
>> > rename from tools/intel_bios_reader.c
>> > rename to tools/intel_vbt_decode.c
>> 
>> -- 
>> Jani Nikula, Intel Open Source Technology Center
>> _______________________________________________
>> Intel-gfx mailing list
>> Intel-gfx@lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/intel-gfx

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx