Chapter 14. Review History

QuickRev can show you the review history of each version of a file.
Furthermore it can set the base version of a review file automatically to the last reviewed version of this file to perform reviews on files without gaps in the review history. For usage of the Task List the history database is needed as well.

Note

The review history can be configured via the Project → Review History menu.
For more information about the configuration of the review history

Configure History ...

The following dialog shows the review history of a file.

Figure 14.1. Review History Dialog

The review coverage of a file will be shown here. QuickRev distinguishes between four different states.
- There are older versions which are not covered by any review. (Review gaps found.)
- The latest versions are not covered by any review.
- All versions are covered by reviews.
- Not all versions have been loaded! - In this case QuickRev does not know the review state because the review history of the not loaded versions are not available. A Reload button will be shown and you can reload the versions.
All available versions will be shown. More information about a file version can be accessed via tool tips (move mouse over the version). The dialog shows the versions only, which have been loaded. If QuickRev is configured not to load all file versions by default you can reload them via the Reload button on the File References tab for a single file or via the menu Project → Reload File Versions for all files. The number of versions to be loaded by default can be configured via the Preferences dialog. For more information about the used colors open the Legend at the bottom of the dialog.
This bar marks the versions which are covered by the current review.
Every bar represents a different review, which is assigned to the versions covered by the review. More information about the review can be accessed via tool tips (move mouse over bar). Different colors represent different states of the reviews, and the versions used in the review (Base, Review, FollowUp, Verification) will be shown with a corresponding letter. For more information about this open the Legend via the link at the bottom of the dialog.
This link opens the legend which explains the colors and signs used in this dialog.

Figure 14.2. Review History Selection

Use the History button to open the Review History dialog of the corresponding file.

14.1. Command Line Options

USAGE:
  java -jar QuickRev.jar --history [OPTIONS]

OPTIONS:
  [<db-dir>]
        Defines the directory where the history-DB is stored.
        If this option is omitted the database will be stored in '~/.quickRev/history'.

  [-h|--help]
        Prints this help.

  --find <start-dir...>
        Searches recursively for review files starting in the given directories and adds them to the history-DB.

  --find-N <dir...>
        Searches for review files in the given directories and adds them to the history-DB.

  [--find-dir <dir-name, start-dir...>]
        Searches recursively for all directories with the given 'dir-name' starting at the given 'start-dir'
        and adds the found directories to the history-DB.
        Use --update to search for the review files in the added directories, both options can be given at the same time.

  --add <file..., dir...>
        Adds given review files and directories to the history-DB.
        Use --update to search for the review files in the added directories, both options can be given at the same time.

  --remove <file..., dir...>
        Removes given review files and directories from the history-DB.
        This command will be executed before 'add' / 'find' and 'update' commands if they are given together.

  [--update]
        Searches in all directories known in the history-DB for review files and adds or updates the found review files.

  [--update-git-worktree]
        History DB update for the current GIT worktree only.

  [--exclude <dir-pattern...>]
        Excludes directory paths which contain the regular expressions from search (increases search performance).

  [--exclude-file <file>]
        Excludes directory paths which contain the regular expressions specified in the given file from search.
        Every regular expression has to be defined in a new line.

  [--clear]
        Removes all entries from the review history.
        This command will be executed first if more arguments are given.

  [--cleanup]
        Removes all directories and review files from the history-DB which do not exist anymore.

  [--tasks [<user-name...>]]
        Prints a task list of all unfinished reviews for the given user(s).
        Use 'ALL' to print a task list for all users or use this options without arguments.

  [--dump]
        Shows the content of the history database.
        This option can be used for error detection reasons.
        Note: do not rely on the database table structure, because it may change with further releases.

  [-c|--config <config-file...>]
        Make use of this option to load the same configuration files as for normal QuickRev usage.

  [--debug[:<WARNING|INFO|CONFIG|FINE|FINER|FINEST|ALL>]]
        This option is useful in case of errors to get additional information.
        Specifying "--debug" only, will show an additional "Debug" menu which provides different debug options.
        Furthermore you can assign a log-level in the form "--debug:ALL" to print logging information of the
        given level to standard error. The following log-levels are available:
        SEVERE (highest value), WARNING, INFO, CONFIG, FINE, FINER, FINEST (lowest value), ALL.
        (See java.util.logging.Level for more information)