elfws 0.4

目录

• Overview
• Key Benefits
• Key Features
• Installation
• Usage
• Documentation
• Contributing

概述

ELFWS是在经过FPGA设计的警告分类后创建的。 合成工具提供了抑制警告的功能，但仅限于警告标识级别。 “放置和布线”工具未提供任何抑制警告的功能。 最终，一项设计变更引发了新的警告。 不幸的是，直到设计过程中很晚才被检测到。 需要更改设计才能解决警告。 这项变更很小，但如果无法解决，可能会导致重大的设计变更。在

主要优点

• 标准化警告抑制定义
• 为不支持抑制的工具提供警告抑制

主要特点

• 警告定义
  • 使用YAML定义抑制规则
  • 可以包括警告抑制的理由
• 持续集成工具支持
• 命令行工具
• 输出JUnit XML文件

安装

您可以通过pip获得最新发布的ELFWS版本。在

pip install elfws

最新的开发版本可以被克隆

…然后在本地安装

python setup.py install

使用

可以在命令行提示符下使用ELFWS调用ELFWS：

$ elfws
usage: elfws [-h]{create,report,show,suppress,version} ...

Suppresses Warnings in logfiles.

positional arguments:
  {create,report,show,suppress,version}
    create              Create suppression file
    report              Generate an audit report
    show                Show warnings in logfiles
    suppress            Suppresses warnings in logfiles
    version             Displays ELFWS version information

optional arguments:
  -h, --help            show this help message and exit

ELFWS有五个子命令：create、report、show、suppress和version。在

创建

使用create子命令从给定的警告文件生成禁止显示规则文件。在

这可以用作禁止显示文件的起点。 应小心，因为输出消息的格式不支持正则表达式。在

可以使用-h选项列出子命令的参数：

$ elfws create -h
usage: elfws create [-h][--suppression_file SUPPRESSION_FILE]
                    log_file output_suppression_file

positional arguments:
  log_file              Log file with warnings to extract
  output_suppression_file
                        Suppression file to create

optional arguments:
  -h, --help            show this help message and exit
  --suppression_file SUPPRESSION_FILE
                        Existing suppression file to filter out existing

报告

使用report子命令生成抑制警告的详细输出。在

报告将显示以下信息：

• 未抑制警告
• 哪些抑制规则抑制了哪些警告
• 未使用的抑制规则
• 被多个禁止显示规则禁止显示的警告
• 抑制规则和警告摘要

确保在报告期间可以使用抑制。在

此命令具有选项参数–junit，它将输出一个junit XML文件。 此文件可与持续集成工具一起使用，以检查新警告。在

可以使用-h选项列出子命令的参数：

$ elfws report -h
usage: elfws report [-h][--junit JUNIT] log_file suppression_file report_file

positional arguments:
  log_file          Log file to check for warnings
  suppression_file  YAML formatted warning suppression file
  report_file       Output report file

optional arguments:
  -h, --help        show this help message and exit
  --junit JUNIT     Generate JUnit XML file JUNIT

显示

使用show子命令列出日志文件中的所有警告。在

当第一次开始禁止显示警告并且禁止显示规则文件不存在时，这可能很有用。在

可以使用-h选项列出子命令的参数：

$ elfws show -h

usage: elfws show [-h] log_file

positional arguments:
  log_file    Log file to show warnings

optional arguments:
  -h, --help  show this help message and exit

抑制

使用suppress子命令可以禁止日志文件中的警告。在

这在创建禁止显示规则文件时非常有用。 它向屏幕报告结果，只显示未被抑制的警告。在

此子命令还可用于支持使用–junit选项的连续集成（CI）流。 –junit选项将创建一个junit XML可由CI工具读取的文件。在

可以使用-h选项列出子命令的参数：

$ elfws suppress -h

usage: elfws suppress [-h] log_file suppression_file

positional arguments:
  log_file          Log file to check for warnings
  suppression_file  YAML formatted warning suppression file

optional arguments:
  -h, --help        show this help message and exit

版本

使用version子命令报告已安装的ELFWS版本。在

此子命令没有参数。在

$ elfws version

EDA Log File Warning Suppressor (ELFWS) version 1.0.0

文件

ELFWS的所有文档都位于read-the-docs。在

贡献

我欢迎对这个项目的任何贡献。 无论大小。在

有几种方法可供选择：

• 错误报告
• 代码库改进
• 功能请求

请参阅位于read-the-docs的文档，了解有关贡献的更多详细信息。在