Project

General

Profile

Bug #10104

Wiki documentation errata

Added by Nikita Chertok 6 months ago. Updated 5 months ago.

Status:
Open
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
Start date:
02/07/2020
Due date:
% Done:

100%

Estimated time:
Detected in build:
master
Platform:
Published in build:

Description

Typos:
  1. Wiki/Command Line Options, Targets:
    1. "Every entity which representation is included into Retrascope is stronlge connected with the tool component called "engine"."
  2. Wiki/Command Line Options, SMT solver debug mode:
    1. Broken link to the Fortress
  3. Wiki/Overview:
    1. Fix line breaks for
      "Models are based on the HDL code and can either be extracted ..."
      "Engines are shown as black round nodes, models are shown as rectangles and artifacts are shown as elliptic nodes."
      "Two components can be combined if one of them returns an entity of some type and the other takes this entity as input."
Suggestions:
  1. Wiki/Getting Started, Command Line Interface:
    1. Add a graphic legend to the dependency graph (as a complement to text)

Files

Retrascope_graph.xml (3.5 KB) Retrascope_graph.xml Dependency graph in Draw.io Nikita Chertok, 02/12/2020 08:09 PM
Retrascope.png (95.5 KB) Retrascope.png Dependency graph Nikita Chertok, 02/12/2020 08:09 PM

History

#1

Updated by Sergey Smolov 6 months ago

  • Status changed from New to Open
#2

Updated by Sergey Smolov 6 months ago

  • % Done changed from 0 to 100
  • Status changed from Open to Resolved
#3

Updated by Sergey Smolov 6 months ago

  • Subject changed from Documentation errata to Wiki documentation errata
#4

Updated by Sergey Smolov 6 months ago

  • Status changed from Resolved to Open
#5

Updated by Nikita Chertok 6 months ago

Typos:
  1. Wiki/Installation Guide:
    1. Broken link to Python Interpreter
    2. Broken link to Command line options
Suggestions:
  1. Wiki/Installation Guide:
    1. If it is possible to use Retrascope with newer version of Z3 (newer than 4.3, current is 4.8.7), specify it.
    2. Add link to forge build page for downloading Retrascope.
    3. Add a one-line Command Line example, running which the user will make sure the installation is successful.
    4. Add "whats next" section with links like:
      1. "For quick overview of common use cases see Getting Started"
      2. "For detailed description of Retrascope see Command Line Options"
      3. Other useful links to documentation
#6

Updated by Sergey Smolov 6 months ago

Fixed. Thanks for the contribution!

#7

Updated by Nikita Chertok 6 months ago

Suggestions:
  1. Wiki/Getting started
    1. Reworked dependency graph image to make it more readable (files in attachment in png and xml for Draw.io)
#8

Updated by Sergey Smolov 6 months ago

Figure is updated.

#9

Updated by Sergey Smolov 6 months ago

  • Detected in build changed from svn to master
  • Assignee changed from Sergey Smolov to Mikhail Lebedev
Wiki/Command Line Options/Engine-specific options
  1. check-method option allows not only "bmc" and "bdd", but "psl-bmc" also. Please provide the full list of acceptable values for this option.
  2. formula-based option is not documented.
  3. spec-file option is not documented.
  4. smv-file option is not documented.
  5. collect-usedef option is not documented.
#10

Updated by Mikhail Lebedev 6 months ago

Model checking-based options fixed.

#11

Updated by Mikhail Lebedev 6 months ago

  • Assignee changed from Mikhail Lebedev to Sergey Smolov

Wiki/Command Line Options
There are no "cgaa" and "clocked guarded atomic actions" in the project anymore. Engine names and descriptions need to be fixed.

#12

Updated by Sergey Smolov 5 months ago

Fixed.

#13

Updated by Sergey Smolov 5 months ago

Command Line Options
Mark obligatory options.

Also available in: Atom PDF