Example 18: Make Report

In a nutshell, (1) is used to dump the names and attributes of files found in a basket, while (2) is used to compare the contents of two or more baskets.

(1) Report on a set of files: Top

Launch TextMaestro. Suppose the current basket has the following files. We would like to make a report on them.

Often we work on a set of files and at the end of the day we want to tell the co-workers what we have worked on. Immediately we wonder, "How can I get the names of a group of files quickly?"

Sure, we can go to the corresponding directories and scrap off the name from cmd console or Windows Rename feature. But that's the hard way. There is an easier way with TextMaestro.

Select the files of interest and click on Report button (Ctrl+R). The dialog shown below will appear.

Note various fields in the list such as Local directory, Remote directory, File name, etc. You can move them up and down using Move up and Move down buttons. Use the check box before the field to include it for report. Also, note Gutter amount for each field, which you can modify using Modify button. Hit Reset to obtain default (shown above). Hit Report button seen on the dialog. The report will be displayed on the Input window. (See below).

If you check on Copy report to the clip-board, then the report placed on the Input window is also placed on the Windows clip-board. Therefore, your previous clip-board contents will be lost, and report will be available for next paste operation.

Report displayed on Input window:

Consider the following set up on Report dialog

for which the report is the following:

You get the idea. With more fields included in the report you will get more columns of text with or without gutters.

(2) Report on a set of baskets: Top

Suppose you have three versions of a package and you want an analysis of what happened from version to version. In particular, we care for the following things for two successive versions:

Were any files added?
Were any files deleted?
Were any files modified?

As an example, we have placed three versions of ias package in three different areas as follows:

TextMaestro can readily make a report on this information. Here are the steps.

Open TextMaestro. Add (F8) a new session if you choose to, or simply stay with the default session. Add (F7) three new baskets on top list namely:

Version 1

Version 2

Version 3

as shown below.

Now we will propagate these three baskets with files from three packages residing in three different areas in your local system.

Next we click on basket Version 1, and drag ias directory from version_dir_1 onto the bottom list. This will open this dialog.

De-select Derive Remote directories based on local paths, and hit OK.

This will propagate all the files from ias folder to the bottom list in flat fashion.

(More information on this dialog is available in Example 3).

Below is the look after the files are added to Version 1 basket.

After files from

\Intel_Assembler\version_1_dir\ias

are populated into basket Version 1, repeat the process for the remaining two ias directories using Version 2 and Version 3 baskets.

Now that all three baskets are loaded with corresponding version of files, we are ready to proceed with the analysis.

Select all three baskets as shown here.

Then select Report button. Report dialog will appear, and select Baskets tab in that dialog as shown below

Accept default values as shown above. While most of the controls here are self explanatory, the control Compare Baskets by examining Local directory tree structure needs some elaboration. By selecting this option, you basically dictate that the files are in local area, and their local path should be used to construct the history on file addition and deletion. (See Technical 16: Report for details).

Hit Report button seen on the dialog. The report will be displayed on the Input window as shown below:

Here is the report in text form:

Files found exclusively in Basket-3: Version 3

----------------------------------------------

file-1.txt

inner\file-1.txt

inner\seh_records.h

inner\seh_records_1.c

inner\unwd.c

inner\unwdec_priv.h

Total 6 files.

Tracing addition and deletion of files:

---------------------------------------

0: Absent, 1: Present

B1 B2 B3

------------

file-1.txt 0 0 1

file-2.txt 0 1 1

inner\file-1.txt 0 0 1

inner\seh_records.h 0 0 1

inner\seh_records_1.c 0 0 1

inner\unwd.c 0 0 1

inner\unwdec_priv.h 0 0 1

Files common to all selected baskets:

-------------------------------------

Makefile

getopt.c

getopt.h

idis.c

idis.h

seh_records.c

seh_records.h

seh_records_1.c

unwd.c

unwdec_priv.h

unwdecem.c

unwdecem.h

unwentry.c

unwentry.h

Total 14 files.

--------------------------------------------------------------------------------

Basket (1): D:\TMT-Plant\QA-Area\Intel_Assembler\version_dir_1\ias\Makefile

Basket (2): D:\TMT-Plant\QA-Area\Intel_Assembler\version_dir_2\ias\Makefile

--------------------------------------------------------------------------------

___(1)___________________________________________________________________________

D 42 #########################################

D 43 # CHECK ENVIRONMENT VARIABLES DEFINITION

D 44 #########################################

___(2)___________________________________________________________________________

___(1)___________________________________________________________________________

47 IDIS_EM = idis$(EEXT)

___(2)___________________________________________________________________________

A 44

45 IDIS_EM = idis$(EEXT)

Top