Compare commits
3 Commits
| Author | SHA1 | Date |
|---|---|---|
|
|
341c271b50 | |
|
|
814803e443 | |
|
|
d2342953d1 |
|
|
@ -14,7 +14,6 @@ on:
|
|||
env:
|
||||
BUILD_PYTHON_FOR_BUILD: "3.10"
|
||||
BUILD_PYTHON_FOR_BUILD_ALIAS: "py310"
|
||||
SKIP_TEST_ON_GITHUB: "True"
|
||||
|
||||
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
|
||||
jobs:
|
||||
|
|
@ -99,7 +98,6 @@ jobs:
|
|||
- "3.10"
|
||||
- "3.11"
|
||||
- "3.12"
|
||||
- "3.13"
|
||||
|
||||
steps:
|
||||
- name: checkout
|
||||
|
|
|
|||
|
|
@ -18,11 +18,7 @@ release_notes.txt
|
|||
# IDE files
|
||||
.idea/
|
||||
.vscode/
|
||||
.venv/
|
||||
.uv-cache/
|
||||
.uv-python/
|
||||
.ci-*/
|
||||
.package-build/
|
||||
venv
|
||||
|
||||
# Ignore external repos used for tests
|
||||
tests/external_repos/repos
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ repos:
|
|||
exclude: '^(.*\.vhd|.*\.svg)$'
|
||||
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v5.0.0
|
||||
rev: v4.5.0
|
||||
hooks:
|
||||
- id: check-added-large-files
|
||||
- id: check-case-conflict
|
||||
|
|
@ -63,14 +63,14 @@ repos:
|
|||
)$"
|
||||
- id: fix-encoding-pragma
|
||||
|
||||
# - repo: https://github.com/mgedmin/check-manifest
|
||||
# rev: "0.50"
|
||||
# hooks:
|
||||
# - id: check-manifest
|
||||
# additional_dependencies:
|
||||
# - setuptools-git-versioning
|
||||
# args:
|
||||
# - --no-build-isolation
|
||||
- repo: https://github.com/mgedmin/check-manifest
|
||||
rev: "0.49"
|
||||
hooks:
|
||||
- id: check-manifest
|
||||
additional_dependencies:
|
||||
- setuptools-git-versioning
|
||||
args:
|
||||
- --no-build-isolation
|
||||
|
||||
- repo: https://github.com/codespell-project/codespell
|
||||
rev: v2.2.6
|
||||
|
|
|
|||
104
DISCLOSURE.md
104
DISCLOSURE.md
|
|
@ -1,104 +0,0 @@
|
|||
# Authorship, LLM Use, and Safety Disclosure
|
||||
|
||||
This document describes the narrow stream-integration fork of VSG: how it was
|
||||
developed, where an LLM was used, what is tested, and which operations can
|
||||
affect source code. It does not make claims about the development process of
|
||||
the complete upstream project.
|
||||
|
||||
## Authorship
|
||||
|
||||
The original VSG parser, rule library, fix engine, command-line application,
|
||||
and most of this repository predate the fork. They are the work of Jeremy C.
|
||||
Leary and upstream contributors. The fork maintainer chose the integration
|
||||
requirements, keeps the patch set deliberately narrow, and accepts releases.
|
||||
|
||||
The fork-specific standard-input and standard-output integration,
|
||||
machine-readable diagnostics, rule-scoped fix adapter, packaging automation,
|
||||
tests, and related documentation were developed or refined with an LLM coding
|
||||
assistant under maintainer direction. Development has been iterative, so this
|
||||
repository does not claim reliable line-by-line attribution between human and
|
||||
LLM-assisted work. The fork commits above the tracked upstream branch keep the
|
||||
integration changes reviewable as a separate patch series.
|
||||
|
||||
## What the fork adds
|
||||
|
||||
The fork builds on VSG's existing `--stdin` and `--no-failure` options and adds
|
||||
a small command-line boundary around existing behavior:
|
||||
|
||||
- `--diagnostics_json` emits a versioned diagnostic document;
|
||||
- `--stdout` emits corrected VHDL instead of writing it to a source file;
|
||||
- `--fix_rule RULE:LINE` adapts a selection to VSG's existing `--fix_only`
|
||||
mechanism; and
|
||||
- packaging and CI exercise the complete stream interface as an installed
|
||||
artifact.
|
||||
|
||||
The parser, rules, phase ordering, and correction engine remain VSG's. The fork
|
||||
does not add a second VHDL parser or formatter.
|
||||
|
||||
## Diagnostic JSON and side effects
|
||||
|
||||
`--diagnostics_json` requires `--stdin` and is incompatible with fixing and
|
||||
other options that claim standard output. VSG parses the submitted text and
|
||||
runs its normal rules, then serializes the resulting findings and effective
|
||||
rule metadata. The JSON does not contain or execute replacement text and does
|
||||
not introduce a path that writes back to the submitted source.
|
||||
|
||||
In this mode, producing JSON cannot change the VHDL, its behavior, or its
|
||||
formatting. Output is always one valid JSON document: successful analysis is
|
||||
marked complete, while argument, configuration, parsing, or unexpected failures
|
||||
produce an incomplete envelope with empty findings and structured error
|
||||
metadata. Details may also go to standard error. The process does not use or
|
||||
contact an LLM at runtime.
|
||||
|
||||
This source-integrity statement is specifically about diagnostic mode. VSG
|
||||
still reads explicitly supplied configuration and local-rule files, and local
|
||||
rules are Python code that must be trusted. Operating-system logging, wrappers,
|
||||
or custom rules are outside this fork's boundary.
|
||||
|
||||
Fixing is intentionally different. With `--stdin --fix --stdout`, VSG returns
|
||||
corrected VHDL on standard output and does not write the input to a source file;
|
||||
a caller such as the bridge may choose to apply that output. If parsing or
|
||||
fixing cannot complete, this stream mode returns the original input unchanged;
|
||||
an empty or partial result is never presented as a correction. Existing VSG
|
||||
file workflows retain their upstream behavior, including any explicitly
|
||||
requested file changes.
|
||||
|
||||
## What is tested
|
||||
|
||||
Focused fork tests cover:
|
||||
|
||||
- required and conflicting option validation;
|
||||
- deterministic, versioned JSON and empty diagnostic collections;
|
||||
- effective severity, fixability, documentation metadata, and Unicode text;
|
||||
- invalid VHDL, invalid configuration, and unexpected failures with a valid
|
||||
incomplete JSON document, including parser locations when available;
|
||||
- rule selector parsing, validation, and deduplication;
|
||||
- selected rules on the same line and across correction phases;
|
||||
- corrections that insert lines; and
|
||||
- unchanged output when a selected rule is unknown.
|
||||
|
||||
CI also runs the upstream unit and style suites, builds both wheel and source
|
||||
distributions, and installs and smoke-tests the wheel through both pip and uv.
|
||||
The smoke tests exercise stdin/stdout formatting from the installed artifact.
|
||||
|
||||
The tests cover known cases; they are not formal verification. In particular,
|
||||
they do not prove VHDL semantic equivalence after formatting, cover every
|
||||
third-party local rule, or remove upstream parser limitations such as embedded
|
||||
PSL and VHDL 2019.
|
||||
|
||||
## Risk by operation
|
||||
|
||||
| Operation | Source-change risk | Main remaining risk |
|
||||
| --- | --- | --- |
|
||||
| `--stdin --diagnostics_json` | None by design | A finding or its metadata may be incomplete or incorrect. |
|
||||
| `--stdin --stdout --fix` | Returns changed text by design | Applying the output may introduce an unwanted formatting change. |
|
||||
| `--fix_rule` | Returns selected changes by design | Correction phases can move later findings, making original line selections stale. |
|
||||
| Existing file-based VSG commands | Unchanged by the fork | They retain the behavior and risks documented by upstream VSG. |
|
||||
|
||||
The machine interface uses one-based line ranges because VSG does not provide
|
||||
generally valid character spans. Consumers must validate the schema and must
|
||||
not reinterpret internal token indexes as source columns.
|
||||
|
||||
For important or safety-critical HDL, keep work in version control, inspect
|
||||
corrected output, and run the normal simulation, synthesis, linting, and review
|
||||
process before accepting a change.
|
||||
|
|
@ -1,172 +0,0 @@
|
|||
// Add the Gitea webhook configured for this Jenkins installation.
|
||||
|
||||
pipeline {
|
||||
agent { label 'rust_no_docker' }
|
||||
|
||||
options {
|
||||
disableConcurrentBuilds()
|
||||
skipDefaultCheckout(true)
|
||||
}
|
||||
|
||||
environment {
|
||||
PYTHONUNBUFFERED = '1'
|
||||
UV_CACHE_DIR = "${WORKSPACE}/.uv-cache"
|
||||
UV_PYTHON_INSTALL_DIR = "${WORKSPACE}/.uv-python"
|
||||
}
|
||||
|
||||
stages {
|
||||
stage('Checkout') {
|
||||
steps {
|
||||
deleteDir()
|
||||
checkout scm
|
||||
sh 'git fetch --force --tags origin'
|
||||
}
|
||||
}
|
||||
|
||||
stage('Set up development environment') {
|
||||
steps {
|
||||
sh '''
|
||||
set -eu
|
||||
command -v uv >/dev/null 2>&1 || {
|
||||
echo "ERROR: uv is required on the Jenkins worker." >&2
|
||||
exit 1
|
||||
}
|
||||
uv --version
|
||||
command -v python3
|
||||
python3 --version
|
||||
uv venv --python python3 .venv
|
||||
uv pip install --python .venv/bin/python -e '.[tests,dev]'
|
||||
'''
|
||||
}
|
||||
}
|
||||
|
||||
stage('Style') {
|
||||
steps {
|
||||
sh 'uv run --no-sync pre-commit run --all-files'
|
||||
}
|
||||
}
|
||||
|
||||
stage('Tests') {
|
||||
steps {
|
||||
sh 'uv run --no-sync python -m unittest'
|
||||
}
|
||||
}
|
||||
|
||||
stage('Build package') {
|
||||
steps {
|
||||
sh './build-package.sh'
|
||||
}
|
||||
}
|
||||
|
||||
stage('Wheel install with pip') {
|
||||
steps {
|
||||
sh '''
|
||||
set -eu
|
||||
wheel="$(find dist -maxdepth 1 -type f -name 'vsg-*.whl' -print -quit)"
|
||||
test -n "${wheel}" || {
|
||||
echo "ERROR: built wheel was not found." >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
python3 -m venv .ci-pip-venv
|
||||
.ci-pip-venv/bin/python -m pip install "${wheel}"
|
||||
|
||||
output="$(
|
||||
printf 'entity smoke is\nend entity smoke;\n' |
|
||||
.ci-pip-venv/bin/vsg --stdin --stdout --fix --style jcl --no-failure
|
||||
)"
|
||||
printf '%s\n' "${output}" | grep -F 'entity SMOKE is'
|
||||
'''
|
||||
}
|
||||
}
|
||||
|
||||
stage('Wheel install with uv') {
|
||||
steps {
|
||||
sh '''
|
||||
set -eu
|
||||
wheel="$(find dist -maxdepth 1 -type f -name 'vsg-*.whl' -print -quit)"
|
||||
test -n "${wheel}" || {
|
||||
echo "ERROR: built wheel was not found." >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
uv venv --python .venv/bin/python .ci-uv-venv
|
||||
uv pip install --python .ci-uv-venv/bin/python "${wheel}"
|
||||
|
||||
output="$(
|
||||
printf 'entity smoke is\nend entity smoke;\n' |
|
||||
.ci-uv-venv/bin/vsg --stdin --stdout --fix --style jcl --no-failure
|
||||
)"
|
||||
printf '%s\n' "${output}" | grep -F 'entity SMOKE is'
|
||||
'''
|
||||
}
|
||||
}
|
||||
|
||||
stage('Archive package') {
|
||||
steps {
|
||||
archiveArtifacts artifacts: 'dist/*', fingerprint: true, onlyIfSuccessful: true
|
||||
}
|
||||
}
|
||||
|
||||
stage('Publish package') {
|
||||
when {
|
||||
branch 'master'
|
||||
}
|
||||
steps {
|
||||
withCredentials([
|
||||
string(
|
||||
credentialsId: 'vsg-gitea-package-token',
|
||||
variable: 'GITEA_TOKEN'
|
||||
)
|
||||
]) {
|
||||
sh '''
|
||||
set +x
|
||||
set -eu
|
||||
|
||||
test -n "${GITEA_TOKEN}" || {
|
||||
echo "ERROR: Jenkins supplied an empty Gitea package token." >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
for artifact in dist/vsg-*.tar.gz dist/vsg-*.whl; do
|
||||
test -f "${artifact}" || {
|
||||
echo "ERROR: expected package artifact was not found: ${artifact}" >&2
|
||||
exit 1
|
||||
}
|
||||
done
|
||||
|
||||
UV_PUBLISH_USERNAME='Dandaedre' \
|
||||
UV_PUBLISH_PASSWORD="${GITEA_TOKEN}" \
|
||||
uv publish \
|
||||
--publish-url 'https://proxy.dandaedre.com/gitea/api/packages/MadGobblins/pypi' \
|
||||
--check-url 'https://proxy.dandaedre.com/gitea/api/packages/MadGobblins/pypi/simple/' \
|
||||
--no-attestations \
|
||||
dist/vsg-*.tar.gz \
|
||||
dist/vsg-*.whl
|
||||
'''
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
post {
|
||||
success {
|
||||
publishChecks(
|
||||
conclusion: 'SUCCESS',
|
||||
name: 'VSG fork CI',
|
||||
summary: 'VSG tests and package installation checks passed.',
|
||||
text: 'The wheel was tested through both pip and uv, including stdin/stdout formatting.',
|
||||
title: 'Build Successful'
|
||||
)
|
||||
}
|
||||
failure {
|
||||
publishChecks(
|
||||
conclusion: 'FAILURE',
|
||||
name: 'VSG fork CI',
|
||||
summary: 'A VSG fork check failed.',
|
||||
text: 'Review the Jenkins log for style, tests, build, installation, or publishing failures.',
|
||||
title: 'Build Failed'
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
92
README.rst
92
README.rst
|
|
@ -22,14 +22,22 @@ VHDL Style Guide (VSG)
|
|||
Announcements
|
||||
-------------
|
||||
|
||||
Update 11/09/2025
|
||||
Update 02/10/2024
|
||||
|
||||
Where has Jeremy been?
|
||||
For Release 3.22.0.
|
||||
|
||||
Just wanted to let everyone know that I have not abandoned this project.
|
||||
There was a family emergency I had to handle and now work is taking a significant amount of my time.
|
||||
In an attempt to be more consistent in the configuration files, the following options are changing from camelCase to snake_case:
|
||||
|
||||
I plan to start working on this again in December.
|
||||
+---------------+--------------+
|
||||
| option | Changed To |
|
||||
+===============+==============+
|
||||
| indentSize | indent_size |
|
||||
+---------------+--------------+
|
||||
| indentStyle | indent_style |
|
||||
+---------------+--------------+
|
||||
|
||||
An Error message will be generated if the old style is encountered.
|
||||
A reminder to change the option to snake_case will be given.
|
||||
|
||||
Regards,
|
||||
|
||||
|
|
@ -148,80 +156,6 @@ Build locally, artifacts will appear in ``dist`` directory.
|
|||
|
||||
tox
|
||||
|
||||
Fork for ``vsg_bridge_ls``
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This fork adds stream integration options so VSG can serve editor buffers.
|
||||
``--diagnostics_json`` reads VHDL from ``--stdin`` and always writes one
|
||||
versioned JSON diagnostic document to standard output. Failed analysis is a
|
||||
valid document marked incomplete rather than missing or malformed JSON. Parser
|
||||
failures include their best available one-based line and column so an editor can
|
||||
replace stale style findings with a useful syntax error.
|
||||
``--stdout`` writes fixed VHDL to standard output; if stdin cannot be parsed or
|
||||
fixing otherwise fails, it returns the original input unchanged so callers get
|
||||
a safe no-op rather than an empty replacement. Repeatable ``--fix_rule
|
||||
RULE:LINE`` arguments restrict
|
||||
``--fix`` to selected rules and one-based lines; they require ``--fix`` and
|
||||
cannot be combined with ``--fix_only``. ``--no-failure`` permits diagnostic
|
||||
findings without a nonzero process status. It is the VSG backend required for
|
||||
`vsg_bridge_ls <https://proxy.dandaedre.com/gitea/MadGobblins/vsg-bridge-ls>`_.
|
||||
The bridge README is the main user guide for installing both projects and
|
||||
configuring an editor.
|
||||
|
||||
LLM disclosure and safety
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* **Human foundation:** the original VSG parser, rules, fix engine, and command
|
||||
line tool predate this fork and are the work of Jeremy C. Leary and upstream
|
||||
contributors. The fork maintainer chooses its scope and accepts releases.
|
||||
* **LLM-assisted work:** the fork-specific stream interface, machine-readable
|
||||
diagnostics, scoped-fix adapter, packaging, tests, and related documentation
|
||||
were developed or refined with an LLM coding assistant under maintainer
|
||||
direction.
|
||||
* **What is tested:** focused tests cover option validation, deterministic JSON,
|
||||
Unicode, clean and invalid input, stdout/stderr separation, selected fixes,
|
||||
and unchanged output for an unknown rule. CI also runs the upstream test and
|
||||
style suites, builds the package, and smoke-tests installed wheels through
|
||||
both pip and uv. Tests reduce risk; they do not prove the absence of defects.
|
||||
* **Practical risk:** ``--diagnostics_json`` only serializes information
|
||||
collected during normal parsing and rule analysis. It does not modify the
|
||||
submitted VHDL, change formatting, write the source file, or use an LLM at
|
||||
runtime. Existing VSG behavior is unchanged when the fork options are absent.
|
||||
Explicit ``--fix``/``--stdout`` operations are different: they intentionally
|
||||
return corrected VHDL, which a caller may then apply. Review generated edits
|
||||
and use version control, especially for safety-critical HDL. See the
|
||||
`full authorship, testing, and risk disclosure <DISCLOSURE.md>`_ for details.
|
||||
|
||||
The preferred installation uses uv and the prebuilt Gitea package:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
uv venv .venv
|
||||
uv pip install --python .venv/bin/python \
|
||||
--index https://proxy.dandaedre.com/gitea/api/packages/MadGobblins/pypi/simple/ \
|
||||
vsg
|
||||
|
||||
Installing from ``master`` also works with uv, and either source works with
|
||||
standard pip. See the bridge's
|
||||
`installation guide <https://proxy.dandaedre.com/gitea/MadGobblins/vsg-bridge-ls/src/branch/main/doc/installation.md>`_
|
||||
for all supported commands and environment setup.
|
||||
|
||||
Fork maintainers can build locally with ``./build-package.sh`` and publish the
|
||||
new artifacts with:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
./build-package.sh ../gitea_token.txt --publish
|
||||
|
||||
On ``master``, Jenkins fetches the Git tags used by
|
||||
``setuptools-git-versioning``, runs both installation smoke tests, archives the
|
||||
generated distributions, and publishes those exact artifacts to Gitea. The
|
||||
required Jenkins credential is documented in the bridge development guide.
|
||||
|
||||
Use ``./update-fork.sh`` to fetch upstream tags and rebase the small fork patch
|
||||
series onto the latest upstream ``master``. The script requires a clean
|
||||
worktree and automatically aborts a failed rebase.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
|
|
|
|||
135
build-package.sh
135
build-package.sh
|
|
@ -1,135 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
set -Eeuo pipefail
|
||||
|
||||
show_help() {
|
||||
cat <<'EOF'
|
||||
Usage: ./build-package.sh [TOKEN_FILE] [--publish]
|
||||
|
||||
Build the VSG source distribution and wheel. With --publish, upload the newly
|
||||
built artifacts to Gitea. TOKEN_FILE overrides all other token sources.
|
||||
|
||||
Optional publishing settings:
|
||||
GITEA_TOKEN token value used when TOKEN_FILE is omitted
|
||||
GITEA_TOKEN_FILE
|
||||
token file used when TOKEN_FILE and GITEA_TOKEN are omitted
|
||||
(default: ../gitea_token.txt)
|
||||
GITEA_USERNAME Gitea login name (default: Dandaedre)
|
||||
GITEA_OWNER package owner (default: MadGobblins)
|
||||
GITEA_URL Gitea base URL (default: https://proxy.dandaedre.com/gitea)
|
||||
EOF
|
||||
}
|
||||
|
||||
fail_usage() {
|
||||
echo "ERROR: $1" >&2
|
||||
show_help >&2
|
||||
exit 2
|
||||
}
|
||||
|
||||
publish=false
|
||||
token_file_argument=""
|
||||
while [ "$#" -gt 0 ]; do
|
||||
case "$1" in
|
||||
--publish)
|
||||
[ "${publish}" = false ] || fail_usage "--publish was specified more than once."
|
||||
publish=true
|
||||
;;
|
||||
-h|--help)
|
||||
show_help
|
||||
exit 0
|
||||
;;
|
||||
-*)
|
||||
fail_usage "unknown option: $1"
|
||||
;;
|
||||
*)
|
||||
[ -z "${token_file_argument}" ] || fail_usage "more than one token file was specified."
|
||||
token_file_argument="$1"
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
if [ -n "${token_file_argument}" ] && [ "${publish}" = false ]; then
|
||||
fail_usage "TOKEN_FILE requires --publish."
|
||||
fi
|
||||
|
||||
repo_root="$(git rev-parse --show-toplevel 2>/dev/null)" || {
|
||||
echo "ERROR: build-package.sh must run inside a Git worktree." >&2
|
||||
exit 1
|
||||
}
|
||||
gitea_token="${GITEA_TOKEN:-}"
|
||||
if [ -n "${token_file_argument}" ]; then
|
||||
gitea_token=""
|
||||
gitea_token_file="${token_file_argument}"
|
||||
else
|
||||
gitea_token_file="${GITEA_TOKEN_FILE:-${repo_root}/../gitea_token.txt}"
|
||||
fi
|
||||
if [ "${publish}" = true ] && [ -z "${gitea_token}" ]; then
|
||||
if [ ! -f "${gitea_token_file}" ] || [ ! -r "${gitea_token_file}" ]; then
|
||||
fail_usage "token file is not a readable regular file: ${gitea_token_file}"
|
||||
fi
|
||||
IFS= read -r gitea_token <"${gitea_token_file}" || :
|
||||
fi
|
||||
if [ "${publish}" = true ] && [ -z "${gitea_token}" ]; then
|
||||
fail_usage "token file is empty: ${gitea_token_file}"
|
||||
fi
|
||||
|
||||
cd "${repo_root}"
|
||||
|
||||
if ! command -v uv >/dev/null 2>&1; then
|
||||
echo "ERROR: uv is required to build the package." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ ! -x .venv/bin/python ]; then
|
||||
echo "Creating the required local virtual environment..."
|
||||
uv venv .venv
|
||||
fi
|
||||
|
||||
readonly build_dir=".package-build"
|
||||
if [ -e "${build_dir}" ]; then
|
||||
rm -rf -- "${build_dir}"
|
||||
fi
|
||||
|
||||
echo "Building the source distribution and wheel..."
|
||||
uv build --no-sources --out-dir "${build_dir}"
|
||||
|
||||
shopt -s nullglob
|
||||
artifacts=("${build_dir}"/vsg-*.tar.gz "${build_dir}"/vsg-*.whl)
|
||||
if [ "${#artifacts[@]}" -lt 2 ]; then
|
||||
echo "ERROR: uv build completed without producing both expected package formats." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
mkdir -p dist
|
||||
built_artifacts=()
|
||||
for artifact in "${artifacts[@]}"; do
|
||||
destination="dist/${artifact##*/}"
|
||||
cp -- "${artifact}" "${destination}"
|
||||
built_artifacts+=("${destination}")
|
||||
done
|
||||
rm -rf -- "${build_dir}"
|
||||
|
||||
echo "Built package artifacts:"
|
||||
printf ' %s\n' "${built_artifacts[@]}"
|
||||
|
||||
if [ "${publish}" = true ]; then
|
||||
readonly gitea_username="${GITEA_USERNAME:-Dandaedre}"
|
||||
readonly gitea_owner="${GITEA_OWNER:-MadGobblins}"
|
||||
readonly gitea_url="${GITEA_URL:-https://proxy.dandaedre.com/gitea}"
|
||||
|
||||
echo
|
||||
echo "Publishing package artifacts to Gitea..."
|
||||
UV_PUBLISH_USERNAME="${gitea_username}" \
|
||||
UV_PUBLISH_PASSWORD="${gitea_token}" \
|
||||
uv publish \
|
||||
--publish-url "${gitea_url}/api/packages/${gitea_owner}/pypi" \
|
||||
--check-url "${gitea_url}/api/packages/${gitea_owner}/pypi/simple/" \
|
||||
--no-attestations \
|
||||
"${built_artifacts[@]}"
|
||||
echo "Published package artifacts successfully."
|
||||
fi
|
||||
|
||||
echo
|
||||
echo "Install the wheel into a uv environment with:"
|
||||
printf ' uv pip install %q\n' "${built_artifacts[-1]}"
|
||||
|
|
@ -54,7 +54,7 @@ after_002
|
|||
|
||||
|phase_5| |disabled| |error| |alignment|
|
||||
|
||||
This rule checks the **after** keywords are aligned in a clock process.
|
||||
This rule checks the *after* keywords are aligned in a clock process.
|
||||
|
||||
|configuring_keyword_alignment_rules_link|
|
||||
|
||||
|
|
@ -93,7 +93,7 @@ after_003
|
|||
|
||||
|phase_1| |disabled| |error| |structure|
|
||||
|
||||
This rule checks the **after** keywords do not exist in the reset portion of a clock process.
|
||||
This rule checks the *after* keywords do not exist in the reset portion of a clock process.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
@ -124,24 +124,3 @@ This rule checks the **after** keywords do not exist in the reset portion of a c
|
|||
b <= c after 1 ns;
|
||||
end if;
|
||||
end process clk_proc;
|
||||
|
||||
after_500
|
||||
#########
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **after** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
a <= 1 AFTER 10 ns;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
a <= 1 after 10 ns;
|
||||
|
|
|
|||
|
|
@ -6,4 +6,20 @@ Aggregate Rules
|
|||
aggregate_500
|
||||
#############
|
||||
|
||||
This rule has been deprecated and replaced with rule `choice_500 <choice_rules.html#choice-500>`_.
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the *others* keyword in aggregates has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal counter : t_counter := (OTHERS => '1');
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal counter : t_counter := (others => '1');
|
||||
|
|
|
|||
|
|
@ -0,0 +1,13 @@
|
|||
API
|
||||
---
|
||||
|
||||
VSG was written to be included in other tools.
|
||||
The command line script provides one means of using VSG.
|
||||
It also provides an example of how to use the API.
|
||||
|
||||
There are two main modules you will use when incorporating VSG into another program:
|
||||
|
||||
.. toctree::
|
||||
|
||||
vsg.vhdlFile
|
||||
vsg.rule_list
|
||||
|
|
@ -516,7 +516,6 @@ architecture_025
|
|||
This rule checks for valid names for the architecture.
|
||||
Typical architecture names are: RTL, EMPTY, and BEHAVE.
|
||||
This rule allows the user to restrict what can be used for an architecture name.
|
||||
Note that regular expressions are accepted in the **names** field.
|
||||
|
||||
.. NOTE:: This rule is disabled by default.
|
||||
You can enable and configure the names using the following configuration.
|
||||
|
|
@ -532,7 +531,6 @@ Note that regular expressions are accepted in the **names** field.
|
|||
- rtl
|
||||
- empty
|
||||
- behave
|
||||
- my_pattern.*
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
|
|||
|
|
@ -1,47 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Array Constraint Rules
|
||||
----------------------
|
||||
|
||||
array_constraint_100
|
||||
####################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for whitespace before the opening parenthesis.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype my_array3 is my_array2 (open)(7 downto 0);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype my_array3 is my_array2(open)(7 downto 0);
|
||||
|
||||
array_constraint_500
|
||||
####################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **open** keyword in array constraints has the proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype t_my_array is t_array(OPEN)(t_range);
|
||||
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype t_my_array is t_array(open)(t_range);
|
||||
|
|
@ -3,111 +3,6 @@
|
|||
Case Generate Alternative Rules
|
||||
-------------------------------
|
||||
|
||||
case_generate_alternative_100
|
||||
#############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the **when** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
case data generate
|
||||
|
||||
when 3 =>
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
case data generate
|
||||
|
||||
when 3 =>
|
||||
|
||||
case_generate_alternative_101
|
||||
#############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space before the **=>** operator.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
case data generate
|
||||
|
||||
when 3 =>
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
case data generate
|
||||
|
||||
when 3 =>
|
||||
|
||||
case_generate_alternative_200
|
||||
#############################
|
||||
|
||||
|phase_3| |error| |blank_line|
|
||||
|
||||
This rule checks for a blank line below the **=>** keyword.
|
||||
|
||||
|configuring_blank_lines_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
when 0 =>
|
||||
a <= b;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
when 0 =>
|
||||
|
||||
a <= b;
|
||||
|
||||
case_generate_alternative_201
|
||||
#############################
|
||||
|
||||
|phase_3| |error| |blank_line|
|
||||
|
||||
This rule checks for blank lines or comments above the **when** keyword.
|
||||
|
||||
|configuring_previous_line_rules_link|
|
||||
|
||||
The default style is :code:`allow_comment`.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
case data is
|
||||
when 3 =>
|
||||
-- Comment
|
||||
when 4 =>
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
case data is
|
||||
|
||||
when 3 =>
|
||||
|
||||
-- Comment
|
||||
when 4 =>
|
||||
|
||||
case_generate_alternative_300
|
||||
#############################
|
||||
|
||||
|
|
@ -118,7 +13,7 @@ case_generate_alternative_500
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **when** keyword has proper case.
|
||||
This rule checks the *when* keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
@ -137,4 +32,20 @@ This rule checks the **when** keyword has proper case.
|
|||
case_generate_alternative_501
|
||||
#############################
|
||||
|
||||
This rule has been deprecated and replaced with rule `choice_500 <choice_rules.html#choice-500>`_.
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the *others* keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
when OTHERS =>
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
when others =>
|
||||
|
|
|
|||
|
|
@ -3,75 +3,6 @@
|
|||
Case Generate Statement Rules
|
||||
-----------------------------
|
||||
|
||||
case_generate_statement_100
|
||||
###########################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the **case** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
case data generate
|
||||
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
case data generate
|
||||
|
||||
case_generate_statement_101
|
||||
###########################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space before the **generate** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
case data generate
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
case data generate
|
||||
|
||||
case_generate_statement_200
|
||||
###########################
|
||||
|
||||
|phase_3| |error| |blank_line|
|
||||
|
||||
This rule checks for blank lines or comments above the **end** keyword.
|
||||
|
||||
|configuring_blank_lines_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
when others =>
|
||||
null;
|
||||
end generate;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
when others =>
|
||||
null;
|
||||
|
||||
end generate;
|
||||
|
||||
case_generate_statement_400
|
||||
###########################
|
||||
|
||||
|
|
@ -108,7 +39,7 @@ case_generate_statement_500
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **case** keyword has proper case.
|
||||
This rule checks the *case* keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
@ -129,7 +60,7 @@ case_generate_statement_501
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **generate** keyword has proper case.
|
||||
This rule checks the *generate* keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
|
|||
|
|
@ -539,7 +539,6 @@ case_300
|
|||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks the indentation of the label.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
|
@ -559,4 +558,20 @@ This rule checks the indentation of the label.
|
|||
case_500
|
||||
########
|
||||
|
||||
This rule has been deprecated and replaced with rule `choice_500 <choice_rules.html#choice-500>`_.
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the *others* keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
when OTHERS =>
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
when others =>
|
||||
|
|
|
|||
|
|
@ -1,25 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Choice Rules
|
||||
------------
|
||||
|
||||
choice_500
|
||||
##########
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **others** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
'0' when OTHERS;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
'0' when others;
|
||||
|
|
@ -86,7 +86,7 @@ Multiple identifiers can be added to a single tag..
|
|||
-- vsg_disable_next_line process_018
|
||||
end process;
|
||||
|
||||
In the above example, process_016 will only be disabled for the line with the **process** keyword.
|
||||
In the above example, process_016 will only be disabled for the line with the process keyword.
|
||||
Successive processes without labels will be flagged by process_016.
|
||||
|
||||
Sequential next line exclusions will also be honored:
|
||||
|
|
@ -102,7 +102,7 @@ Sequential next line exclusions will also be honored:
|
|||
-- vsg_disable_next_line process_018
|
||||
end process;
|
||||
|
||||
In the above example, both process_002 and process_016 will be disabled for the line starting with the **process** keyword.
|
||||
In the above example, both process_002 and process_016 will be disabled for the line starting with the process keyword.
|
||||
|
||||
Comments in code tags
|
||||
---------------------
|
||||
|
|
|
|||
|
|
@ -33,8 +33,6 @@ comment_010
|
|||
|
||||
This rule checks the indent lines starting with comments.
|
||||
|
||||
|configuring_comment_indenting_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
|
|
|||
|
|
@ -34,8 +34,6 @@ import vsg.version
|
|||
# ones.
|
||||
extensions = ["sphinx.ext.coverage", "sphinx.ext.autodoc", "sphinx.ext.autosectionlabel", "sphinx_rtd_theme"]
|
||||
|
||||
suppress_warnings = ["autosectionlabel.*"]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ["_templates"]
|
||||
|
||||
|
|
@ -91,9 +89,11 @@ html_theme = "sphinx_rtd_theme"
|
|||
#
|
||||
html_theme_options = {
|
||||
"logo_only": False,
|
||||
"display_version": True,
|
||||
"prev_next_buttons_location": "bottom",
|
||||
"style_external_links": False,
|
||||
"vcs_pageview_mode": "",
|
||||
# 'style_nav_header_background': 'white',
|
||||
# ToC options
|
||||
"collapse_navigation": False,
|
||||
"sticky_navigation": True,
|
||||
|
|
@ -105,7 +105,7 @@ html_theme_options = {
|
|||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
# html_static_path = ["_static"]
|
||||
html_static_path = ["_static"]
|
||||
|
||||
# Custom sidebar templates, must be a dictionary that maps document names
|
||||
# to template names.
|
||||
|
|
|
|||
|
|
@ -9,7 +9,6 @@ Configuring
|
|||
configuring_array_multiline_structure_rules.rst
|
||||
configuring_blank_lines.rst
|
||||
configuring_block_comments.rst
|
||||
configuring_comment_indenting.rst
|
||||
configuring_comment_keywords.rst
|
||||
configuring_conditional_multiline_indent_rules.rst
|
||||
configuring_consecutive_blank_line_rules.rst
|
||||
|
|
@ -19,13 +18,11 @@ Configuring
|
|||
configuring_indent_rules.rst
|
||||
configuring_keyword_alignment_rules.rst
|
||||
configuring_length_rules.rst
|
||||
configuring_library_and_package_name_restriction_rules.rst
|
||||
configuring_move_token_rules.rst
|
||||
configuring_multiline_assert_rule.rst
|
||||
configuring_multiline_constraint_rules.rst
|
||||
configuring_multiline_indent_rules.rst
|
||||
configuring_number_of_signals_in_signal_declaration.rst
|
||||
configuring_number_of_variables_in_variable_declaration.rst
|
||||
configuring_optional_items.rst
|
||||
configuring_port_map_new_line.rst
|
||||
configuring_port_mode_alignment.rst
|
||||
|
|
@ -39,7 +36,6 @@ Configuring
|
|||
configuring_type_of_instantiations.rst
|
||||
configuring_uppercase_and_lowercase_rules.rst
|
||||
configuring_use_clause_indenting.rst
|
||||
configuring_user_error_messages.rst
|
||||
configuring_whitespace_rules.rst
|
||||
configuring_whitespace_after_comment_rules.rst
|
||||
configuring_vhdl_reserved_words.rst
|
||||
|
|
|
|||
|
|
@ -566,6 +566,4 @@ Rules Enforcing Array Multiline Structure Rules
|
|||
* `concurrent_012 <concurrent_rules.html#concurrent-012>`_
|
||||
* `constant_016 <constant_rules.html#constant-016>`_
|
||||
* `sequential_009 <sequential_rules.html#sequential-009>`_
|
||||
* `signal_403 <signal_rules.html#signal-403>`_
|
||||
* `variable_403 <variable_rules.html#variable-403>`_
|
||||
* `variable_assignment_008 <variable_assignment_rules.html#variable-assignment-008>`_
|
||||
|
|
|
|||
|
|
@ -146,8 +146,6 @@ Rules Enforcing Blank Lines
|
|||
* `case_009 <case_rules.html#case-009>`_
|
||||
* `case_010 <case_rules.html#case-010>`_
|
||||
* `case_200 <case_rules.html#case-200>`_
|
||||
* `case_generate_alternative_200 <case_generate_alternative_rules.html#case-generate-alternative-200>`_
|
||||
* `case_generate_statement_200 <case_generate_statement_rules.html#case-generate-statement-200>`_
|
||||
* `component_016 <component_rules.html#component-016>`_
|
||||
* `component_018 <component_rules.html#component-018>`_
|
||||
* `constant_200 <constant_rules.html#constant-200>`_
|
||||
|
|
@ -168,11 +166,10 @@ Rules Enforcing Blank Lines
|
|||
* `package_body_201 <package_body_rules.html#package-body-201>`_
|
||||
* `package_body_202 <package_body_rules.html#package-body-202>`_
|
||||
* `package_body_203 <package_body_rules.html#package-body-203>`_
|
||||
* `package_instantiation_201 <package_instantiation_rules.html#package-instantiation-201>`_
|
||||
* `port_001 <port_rules.html#port-001>`_
|
||||
* `port_map_200 <port_map_rules.html#port-map-200>`_
|
||||
* `pragma_401 <pragma_rules.html#pragma-401>`_
|
||||
* `pragma_403 <pragma_rules.html#pragma-403>`_
|
||||
* `pragma_401 <../pragma_rules.html#pragma-401>`_
|
||||
* `pragma_403 <../pragma_rules.html#pragma-403>`_
|
||||
* `process_011 <process_rules.html#process-011>`_
|
||||
* `process_021 <process_rules.html#process-021>`_
|
||||
* `process_022 <process_rules.html#process-022>`_
|
||||
|
|
@ -186,7 +183,7 @@ Rules Enforcing Blank Lines
|
|||
* `subprogram_body_203 <subprogram_body_rules.html#subprogram-body-203>`_
|
||||
* `subprogram_body_204 <subprogram_body_rules.html#subprogram-body-204>`_
|
||||
* `subprogram_body_205 <subprogram_body_rules.html#subprogram-body-205>`_
|
||||
* `subtype_200 <subtype_rules.html#subtype-200>`_
|
||||
* `subtype_202 <subtype_rules.html#subtype-202>`_
|
||||
* `subtype_200 <../subtype_rules.html#subtype-200>`_
|
||||
* `subtype_202 <../subtype_rules.html#subtype-202>`_
|
||||
* `type_011 <type_rules.html#type-011>`_
|
||||
* `type_200 <type_rules.html#type-200>`_
|
||||
|
|
|
|||
|
|
@ -121,20 +121,20 @@ To configure the following example...
|
|||
|
||||
rule:
|
||||
block_comment_001:
|
||||
disable: false
|
||||
header_left:
|
||||
header_left_repeat: '-'
|
||||
header_string:
|
||||
header_right_repeat:
|
||||
disable : False
|
||||
header_left : ''
|
||||
header_left_repeat : '-'
|
||||
header_string : ''
|
||||
header_right_repeat : ''
|
||||
block_comment_002:
|
||||
disable: false
|
||||
comment_left:
|
||||
disable : False
|
||||
comment_left : ''
|
||||
block_comment_003:
|
||||
disable: false
|
||||
footer_left:
|
||||
footer_left_repeat: '-'
|
||||
footer_string:
|
||||
footer_right_repeat:
|
||||
disable : False
|
||||
footer_left : ''
|
||||
footer_left_repeat : '-'
|
||||
footer_string : ''
|
||||
footer_right_repeat : ''
|
||||
|
||||
Complex Block Comment
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
|
|||
|
|
@ -1,153 +0,0 @@
|
|||
.. _configuring-comment-indenting:
|
||||
|
||||
Configuring Comment Indenting
|
||||
-----------------------------
|
||||
|
||||
The desired indenting of comments can vary depending on where the comment occurs.
|
||||
|
||||
There are currently two options for configuring indents.
|
||||
|
||||
.. |boolean_value| replace::
|
||||
:code:`<boolean>`
|
||||
|
||||
.. |True| replace::
|
||||
:code:`True`
|
||||
|
||||
.. |False| replace::
|
||||
:code:`False`
|
||||
|
||||
.. |align_with_end_of_declarative_part| replace::
|
||||
:code:`align_with_end_of_declarative_part`
|
||||
|
||||
.. |align_with_end_of_statement_part| replace::
|
||||
:code:`align_with_end_of_statement_part`
|
||||
|
||||
.. |align_with_end_of_part_default| replace::
|
||||
|False|
|
||||
|
||||
.. |align_with_end_of_part_True| replace::
|
||||
|True| = Sets indent to current indent level.
|
||||
|
||||
.. |align_with_end_of_part_False| replace::
|
||||
|False| = Sets indent to next indent level.
|
||||
|
||||
+--------------------------------------+-----------------+---------------+----------------------------------+
|
||||
| Option | Values | Default | Description |
|
||||
+======================================+=================+===============+==================================+
|
||||
| |align_with_end_of_declarative_part| | |boolean_value| | :code:`False` | * |align_with_end_of_part_True| |
|
||||
| | | | * |align_with_end_of_part_False| |
|
||||
+--------------------------------------+-----------------+---------------+----------------------------------+
|
||||
| |align_with_end_of_statement_part| | |boolean_value| | :code:`False` | * |align_with_end_of_part_True| |
|
||||
| | | | * |align_with_end_of_part_False| |
|
||||
+--------------------------------------+-----------------+---------------+----------------------------------+
|
||||
|
||||
This is an example of how to configure these options.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
indent:
|
||||
options:
|
||||
comment:
|
||||
align_with_end_of_declarative_part: False
|
||||
align_with_end_of_statement_part: False
|
||||
|
||||
The following code snippet is used for all examples.
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
signal a : std_logic;
|
||||
-- end of signal declarations
|
||||
|
||||
begin
|
||||
|
||||
o_output <= a;
|
||||
-- end of output assignments
|
||||
|
||||
end architecture rtl;
|
||||
|
||||
Example: |align_with_end_of_declarative_part| set to |True|
|
||||
###########################################################
|
||||
|
||||
The |align_with_end_of_declarative_part| option controls the indent of comments at the end of a declarative part.
|
||||
Setting this option to |True| will set the indent of the comment to the previous indent level.
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
signal a : std_logic;
|
||||
-- end of signal declarations
|
||||
|
||||
begin
|
||||
|
||||
o_output <= a;
|
||||
-- end of output assignments
|
||||
|
||||
end architecture rtl;
|
||||
|
||||
Example: |align_with_end_of_declarative_part| set to |False|
|
||||
############################################################
|
||||
|
||||
The |align_with_end_of_declarative_part| option controls the indent of comments at the end of a declarative part.
|
||||
Setting this option to |False| will set the indent of the comment to the next indent level.
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
signal a : std_logic;
|
||||
-- end of signal declarations
|
||||
|
||||
begin
|
||||
|
||||
o_output <= a;
|
||||
-- end of output assignments
|
||||
|
||||
end architecture rtl;
|
||||
|
||||
Example: |align_with_end_of_statement_part| set to |True|
|
||||
#########################################################
|
||||
|
||||
The |align_with_end_of_statement_part| option controls the indent of comments at the end of a statement part.
|
||||
Setting this option to |True| will set the indent of the comment to the previous indent level.
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
signal a : std_logic;
|
||||
-- end of signal declarations
|
||||
|
||||
begin
|
||||
|
||||
o_output <= a;
|
||||
-- end of output assignments
|
||||
|
||||
end architecture rtl;
|
||||
|
||||
Example: |align_with_end_of_statement_part| set to |False|
|
||||
##########################################################
|
||||
|
||||
The |align_with_end_of_statement_part| option controls the indent of comments at the end of a statement part.
|
||||
Setting this option to |False| will set the indent of the comment to the next indent level.
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
signal a : std_logic;
|
||||
-- end of signal declarations
|
||||
|
||||
begin
|
||||
|
||||
o_output <= a;
|
||||
-- end of output assignments
|
||||
|
||||
end architecture rtl;
|
||||
|
||||
Rules Enforcing Comment Indenting
|
||||
#################################
|
||||
|
||||
* `comment_010 <comment_rules.html#comment-010>`_
|
||||
|
|
@ -59,9 +59,6 @@ Rules Disabled by Default
|
|||
* `generic_map_601 <generic_map_rules.html#generic-map-601>`_
|
||||
* `instantiation_600 <instantiation_rules.html#instantiation-600>`_
|
||||
* `instantiation_601 <instantiation_rules.html#instantiation-601>`_
|
||||
* `interface_incomplete_type_declaration_600 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-600>`_
|
||||
* `interface_incomplete_type_declaration_601 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-601>`_
|
||||
* `library_012 <library_rules.html#library-012>`_
|
||||
* `loop_statement_006 <loop_statement_rules.html#loop-statement-006>`_
|
||||
* `loop_statement_007 <loop_statement_rules.html#loop-statement-007>`_
|
||||
* `loop_statement_600 <loop_statement_rules.html#loop-statement-600>`_
|
||||
|
|
@ -72,8 +69,6 @@ Rules Disabled by Default
|
|||
* `package_017 <package_rules.html#package-017>`_
|
||||
* `package_body_600 <package_body_rules.html#package-body-600>`_
|
||||
* `package_body_601 <package_body_rules.html#package-body-601>`_
|
||||
* `package_instantiation_600 <package_instantiation_rules.html#package-instantiation-600>`_
|
||||
* `package_instantiation_601 <package_instantiation_rules.html#package-instantiation-601>`_
|
||||
* `port_011 <port_rules.html#port-011>`_
|
||||
* `port_025 <port_rules.html#port-025>`_
|
||||
* `port_600 <port_rules.html#port-600>`_
|
||||
|
|
@ -101,7 +96,6 @@ Rules Disabled by Default
|
|||
* `type_100 <type_rules.html#type-100>`_
|
||||
* `type_200 <type_rules.html#type-200>`_
|
||||
* `type_600 <type_rules.html#type-600>`_
|
||||
* `use_clause_001 <use_clause_rules.html#use-clause-001>`_
|
||||
* `variable_012 <variable_rules.html#variable-012>`_
|
||||
* `variable_100 <variable_rules.html#variable-100>`_
|
||||
* `variable_600 <variable_rules.html#variable-600>`_
|
||||
|
|
|
|||
|
|
@ -148,4 +148,3 @@ Rules Enforcing Identifier Alignment
|
|||
* `package_019 <package_rules.html#package-019>`_
|
||||
* `package_body_400 <package_body_rules.html#package-body-400>`_
|
||||
* `procedure_010 <procedure_rules.html#procedure-010>`_
|
||||
* `protected_type_body_400 <protected_type_body_rules.html#protected-type-body-400>`_
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ The :code:`indent_style` option can be set globally for all rules and locally fo
|
|||
|
||||
.. code-block:: yaml
|
||||
|
||||
rule:
|
||||
rules:
|
||||
global:
|
||||
indent_style: 'smart_tabs'
|
||||
indent_size: 2
|
||||
|
|
|
|||
|
|
@ -41,10 +41,10 @@ There are several options to these rules:
|
|||
:code:`separate_generic_port_alignment`
|
||||
|
||||
.. |separate_generic_port_alignment__yes| replace::
|
||||
:code:`yes` = stop if **port** keyword detected.
|
||||
:code:`yes` = stop if port keyword detected.
|
||||
|
||||
.. |separate_generic_port_alignment__no| replace::
|
||||
:code:`no` = continue if **port** keyword detected.
|
||||
:code:`no` = continue if port keyword detected.
|
||||
|
||||
.. |if_control_statements_ends_group| replace::
|
||||
:code:`if_control_statements_ends_group`
|
||||
|
|
@ -904,7 +904,7 @@ In the example below, the others aggregates are ignored which will allow the ENU
|
|||
Example: |align_to| set to :code:`current_indent`
|
||||
#################################################
|
||||
|
||||
For example in rule :code:`process_028` the close parenthesis will be aligned with the **process** keyword.
|
||||
For example in rule :code:`process_028` the close parenthesis will be aligned with the process keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
@ -986,11 +986,7 @@ Rules Enforcing Keyword Alignment
|
|||
* `process_035 <process_rules.html#process-035>`_
|
||||
* `process_400 <process_rules.html#process-400>`_
|
||||
* `process_401 <process_rules.html#process-401>`_
|
||||
* `protected_type_body_401 <protected_type_body_rules.html#protected-type-body-401>`_
|
||||
* `protected_type_body_402 <protected_type_body_rules.html#protected-type-body-402>`_
|
||||
* `sequential_400 <sequential_rules.html#sequential-400>`_
|
||||
* `signal_401 <signal_rules.html#signal-401>`_
|
||||
* `subprogram_body_400 <subprogram_body_rules.html#subprogram-body-400>`_
|
||||
* `subprogram_body_401 <subprogram_body_rules.html#subprogram-body-401>`_
|
||||
* `type_400 <type_rules.html#type-400>`_
|
||||
* `variable_401 <variable_rules.html#variable-401>`_
|
||||
|
|
|
|||
|
|
@ -1,70 +0,0 @@
|
|||
|
||||
.. _configuring-library-and-package-name-restriction-rules:
|
||||
|
||||
Configuring Library and Package Name Restriction Rules
|
||||
------------------------------------------------------
|
||||
|
||||
There are rules which will check for invalid package names in library and use clauses.
|
||||
These rules are disabled by default and must be enabled before they will perform any checks.
|
||||
|
||||
There is one option for these rules:
|
||||
|
||||
.. |names| replace::
|
||||
:code:`names`
|
||||
|
||||
.. |default| replace::
|
||||
:code:`std_logic_arith` for **use_clause_001**. None for **library_012**
|
||||
|
||||
.. |values__names| replace::
|
||||
List of strings
|
||||
|
||||
.. |action__names| replace::
|
||||
Search for libraries and packages with the user defined names
|
||||
|
||||
+--------------------------------------+-----------------+-----------+------------------------------------------------+
|
||||
| Option | Values | Default | Description |
|
||||
+======================================+=================+===========+================================================+
|
||||
| |names| | |values__names| | |default| | * |action__names| |
|
||||
+--------------------------------------+-----------------+-----------+------------------------------------------------+
|
||||
|
||||
This is an example of how to configure the option.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
rule :
|
||||
library_012:
|
||||
names:
|
||||
- "work"
|
||||
- "std_logic_arith"
|
||||
|
||||
.. NOTE:: All examples below are using the rule **use_clause_001**.
|
||||
|
||||
Example: |names| set to list ["std_logic_arith"]
|
||||
################################################
|
||||
|
||||
The following code would fail with this option:
|
||||
|
||||
.. code-Block:: vhdl
|
||||
|
||||
library ieee;
|
||||
use ieee.std_logic_arith.all;
|
||||
|
||||
Example: |names| set to ["std_logic_arith", "my_package"]
|
||||
##############################################
|
||||
|
||||
The following code would fail three times with this option:
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
library ieee;
|
||||
use ieee.std_logic_arith.all;
|
||||
|
||||
library work;
|
||||
use work.my_package.all;
|
||||
|
||||
|
||||
Rules Enforcing Valid Names
|
||||
###########################
|
||||
|
||||
* `library_012 <library_rules.html#library-012>`_
|
||||
* `use_clause_001 <use_clause_rules.html#use-clause-001>`_
|
||||
|
|
@ -14,13 +14,13 @@ The method of indenting can be configured using one of the following options:
|
|||
The setting :code:`left` enforces multiline report statements using indents.
|
||||
|
||||
.. |report_description| replace::
|
||||
The setting :code:`report` aligns multiline report statements to the **report** keyword.
|
||||
The setting :code:`report` aligns multiline report statements to the report keyword.
|
||||
|
||||
.. |values| replace::
|
||||
:code:`left`, :code:`report`
|
||||
|
||||
.. |default_value| replace::
|
||||
:code:`report`
|
||||
:code:`left`
|
||||
|
||||
.. |report| replace::
|
||||
:code:'report`
|
||||
|
|
@ -46,7 +46,7 @@ This is an example of how to configure these options.
|
|||
Example: |alignment| set to |report|
|
||||
####################################
|
||||
|
||||
Align report expressions with the **report** keyword.
|
||||
Align report expressions with the report keyword.
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
|
|
@ -58,7 +58,7 @@ Align report expressions with the **report** keyword.
|
|||
Example: |alignment| set to |left|
|
||||
##################################
|
||||
|
||||
Align report expressions an additional indent level from the **report** keyword.
|
||||
Align report expressions an additional indent level from the report keyword.
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
|
|
|
|||
|
|
@ -127,8 +127,6 @@ Rules Enforcing Multiline Indent Rules
|
|||
* `sequential_004 <sequential_rules.html#sequential-004>`_
|
||||
* `sequential_402 <sequential_rules.html#sequential-402>`_
|
||||
* `signal_400 <signal_rules.html#signal-400>`_
|
||||
* `signal_402 <signal_rules.html#signal-402>`_
|
||||
* `variable_400 <signal_rules.html#variable-400>`_
|
||||
* `variable_402 <variable_rules.html#variable-402>`_
|
||||
* `variable_assignment_004 <variable_assignment_rules.html#variable-assignment-004>`_
|
||||
* `variable_assignment_401 <variable_assignment_rules.html#variable-assignment-401>`_
|
||||
|
|
|
|||
|
|
@ -1,30 +0,0 @@
|
|||
|
||||
.. _configuring-number-of-variables-in-variable-declaration:
|
||||
|
||||
Configuring Number of Variables in Variable Declaration
|
||||
-------------------------------------------------------
|
||||
|
||||
VHDL allows of any number of variables to be declared within a single variable declaration.
|
||||
While this may be allowed, in practice there are limits imposed by the designers.
|
||||
Limiting the number of variables declared improves the readability of VHDL code.
|
||||
|
||||
The default number of variables allowed, 2, can be set by configuring rule **variable_015**.
|
||||
|
||||
Overriding Number of variables
|
||||
##############################
|
||||
|
||||
The default setting can be changed using a configuration.
|
||||
We can use the following configuration to change the number of variables allowed to 1.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
---
|
||||
|
||||
rule :
|
||||
variable_015 :
|
||||
consecutive : 1
|
||||
|
||||
Rules Enforcing Number of variables
|
||||
###################################
|
||||
|
||||
* `variable_015 <variable_rules.html#variable-015>`_
|
||||
|
|
@ -98,7 +98,6 @@ Rules Enforcing Optional Items
|
|||
* `function_020 <function_rules.html#function-020>`_
|
||||
* `generate_011 <generate_rules.html#generate-011>`_
|
||||
* `instantiation_033 <instantiation_rules.html#instantiation-033>`_
|
||||
* `instantiation_036 <instantiation_rules.html#instantiation-036>`_
|
||||
* `loop_statement_007 <loop_statement_rules.html#loop-statement-007>`_
|
||||
* `package_007 <package_rules.html#package-007>`_
|
||||
* `package_014 <package_rules.html#package-014>`_
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
Configuring Port Map New Line
|
||||
-----------------------------
|
||||
|
||||
There is a rule which will check for new lines before the **port** keyword in port map aspects relative to what preceded it.
|
||||
There is a rule which will check for new lines before the port keyword in port map aspects relative to what preceded it.
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
|
|
|
|||
|
|
@ -62,44 +62,40 @@ The keywords are treated as case insensitive and support regular expressions.
|
|||
Rules Enforcing Prefixes and Suffixes
|
||||
#####################################
|
||||
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **Element** | **Prefix Rule** | **Suffix Rule** |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Block Label | `block_601 <block_rules.html#block-601>`_ | `block_600 <block_rules.html#block-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Constant Identifier | `constant_015 <constant_rules.html#constant-015>`_ | `constant_600 <constant_rules.html#constant-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Function Designator | `function_600 <function_rules.html#function-600>`_ | `function_601 <function_rules.html#function-601>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Generate Label | `generate_017 <generate_rules.html#generate-017>`_ | `generate_600 <generate_rules.html#generate-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Generate Parameter Identifier | `generate_601 <generate_rules.html#generate-601>`_ | `generate_602 <generate_rules.html#generate-602>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Generic Identifier | `generic_020 <generic_rules.html#generic-020>`_ | `generic_600 <generic_rules.html#generic-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Generic Map Identifier | `generic_map_601 <generic_map_rules.html#generic-map-601>`_ | `generic_map_600 <generic_map_rules.html#generic-map-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Loop Label | `loop_600 <loop_statement_rules.html#loop-statement-600>`_ | `loop_601 <loop_statement_rules.html#loop-statement-601>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Loop Parameter Identifier | `loop_602 <loop_statement_rules.html#loop-statement-602>`_ | `loop_603 <loop_statement_rules.html#loop-statement-603>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Generic Type Identifier | `interface_incomplete_type_declaration_600 <interface_incomplete_type_declaration.html#interface-incomplete-type-declaration-600>`_ | `interface_incomplete_type_declaration_601 <interface_incomplete_type_declaration.html#interface-incomplete-type-declaration-601>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Package Identifier | `package_017 <package_rules.html#package-017>`_ | `package_016 <package_rules.html#package-016>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Package Body Identifier | `package_body_601 <package_body_rules.html#package-body-601>`_ | `package_body_600 <package_body_rules.html#package-body-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Package Instantiation Identifier | `package_instantiation_601 <package_instantiation_rules.html#package-instantiation-601>`_ | `package_instantiation_600 <package_instantiation_rules.html#package-instantiation-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Port Identifier | `port_011 <port_rules.html#port-011>`_ | `port_025 <port_rules.html#port-025>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Process Label | `process_036 <process_rules.html#process-036>`_ | `process_600 <process_rules.html#process-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Signal Identifier | `signal_008 <signal_rules.html#signal-008>`_ | `signal_600 <signal_rules.html#signal-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Subtype Identifier | `subtype_004 <subtype_rules.html#subtype-004>`_ | `subtype_600 <subtype_rules.html#subtype-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Type Identifier | `type_definition_015 <type_rules.html#type-015>`_ | `type_definition_600 <type_rules.html#type-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Variable Identifier | `variable_012 <variable_rules.html#variable-012>`_ | `variable_600 <variable_rules.html#variable-600>`_ |
|
||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| **Element** | **Prefix Rule** | **Suffix Rule** |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Block Label | `block_601 <block_rules.html#block-601>`_ | `block_600 <block_rules.html#block-600>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Constant Identifier | `constant_015 <constant_rules.html#constant-015>`_ | `constant_600 <constant_rules.html#constant-600>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Function Designator | `function_600 <function_rules.html#function-600>`_ | `function_601 <function_rules.html#function-601>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Generate Label | `generate_017 <generate_rules.html#generate-017>`_ | `generate_600 <generate_rules.html#generate-600>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Generate Parameter Identifier | `generate_601 <generate_rules.html#generate-601>`_ | `generate_602 <generate_rules.html#generate-602>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Generic Identifier | `generic_020 <generic_rules.html#generic-020>`_ | `generic_600 <generic_rules.html#generic-600>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Generic Map Identifier | `generic_map_601 <generic_map_rules.html#generic-map-601>`_ | `generic_map_600 <generic_map_rules.html#generic-map-600>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Loop Label | `loop_600 <loop_statement_rules.html#loop-statement-600>`_ | `loop_601 <loop_statement_rules.html#loop-statement-601>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Loop Parameter Identifier | `loop_602 <loop_statement_rules.html#loop-statement-602>`_ | `loop_603 <loop_statement_rules.html#loop-statement-603>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Package Identifier | `package_017 <package_rules.html#package-017>`_ | `package_016 <package_rules.html#package-016>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Package Body Identifier | `package_body_601 <package_body_rules.html#package-body-601>`_ | `package_body_600 <package_body_rules.html#package-body-600>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Port Identifier | `port_011 <port_rules.html#port-011>`_ | `port_025 <port_rules.html#port-025>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Process Label | `process_036 <process_rules.html#process-036>`_ | `process_600 <process_rules.html#process-600>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Signal Identifier | `signal_008 <signal_rules.html#signal-008>`_ | `signal_600 <signal_rules.html#signal-600>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Subtype Identifier | `subtype_004 <subtype_rules.html#subtype-004>`_ | `subtype_600 <subtype_rules.html#subtype-600>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Type Identifier | `type_definition_015 <type_rules.html#type-015>`_ | `type_definition_600 <type_rules.html#type-600>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
| Variable Identifier | `variable_012 <variable_rules.html#variable-012>`_ | `variable_600 <variable_rules.html#variable-600>`_ |
|
||||
+-------------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
|
||||
|
|
|
|||
|
|
@ -241,7 +241,6 @@ Rules Enforcing Previous Lines
|
|||
* `block_200 <block_rules.html#block-200>`_
|
||||
* `case_007 <case_rules.html#case-007>`_
|
||||
* `case_201 <case_rules.html#case-201>`_
|
||||
* `case_generate_alternative_201 <case_generate_alternative_rules.html#case-generate-alternative-201>`_
|
||||
* `component_003 <component_rules.html#component-003>`_
|
||||
* `context_003 <context_rules.html#context-003>`_
|
||||
* `entity_003 <entity_rules.html#entity-003>`_
|
||||
|
|
@ -255,11 +254,10 @@ Rules Enforcing Previous Lines
|
|||
* `loop_statement_202 <loop_statement_rules.html#loop-statement-202>`_
|
||||
* `package_003 <package_rules.html#package-003>`_
|
||||
* `package_body_200 <package_body_rules.html#package-body-200>`_
|
||||
* `package_instantiation_200 <package_instantiation_rules.html#package-instantiation-200>`_
|
||||
* `pragma_400 <pragma_rules.html#pragma-400>`_
|
||||
* `pragma_402 <pragma_rules.html#pragma-402>`_
|
||||
* `pragma_400 <../pragma_rules.html#pragma-400>`_
|
||||
* `pragma_402 <../pragma_rules.html#pragma-402>`_
|
||||
* `procedure_200 <procedure_rules.html#procedure-200>`_
|
||||
* `process_015 <process_rules.html#process-015>`_
|
||||
* `record_type_definition_201 <record_type_definition_rules.html#record-type-definition-201>`_
|
||||
* `subtype_201 <subtype_rules.html#subtype-201>`_
|
||||
* `subtype_201 <../subtype_rules.html#subtype-201>`_
|
||||
* `type_010 <type_rules.html#type-010>`_
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ There are several options to these rules:
|
|||
+-------------------------+-------------+---------------+-----------------------------------+
|
||||
| Method | Values | Default | Description |
|
||||
+=========================+=============+===============+===================================+
|
||||
| |new_line_after_assign| | |values1| | |default_no| | * |new_line_after_assign__yes| |
|
||||
| |new_line_after_assign| | |values1| | |default_yes| | * |new_line_after_assign__yes| |
|
||||
| | | | * |new_line_after_assign__no| |
|
||||
| | | | * |new_line_after_assign__ignore| |
|
||||
+-------------------------+-------------+---------------+-----------------------------------+
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ This is an example of how to configure these options.
|
|||
.. code-block:: yaml
|
||||
|
||||
rule :
|
||||
instantiation_034:
|
||||
instantiation_010:
|
||||
method: 'component'
|
||||
|
||||
Example: |method| set to |component_option|
|
||||
|
|
|
|||
|
|
@ -23,18 +23,9 @@ There are several options to these rules:
|
|||
.. |camelCase_value| replace::
|
||||
:code:`camelCase`
|
||||
|
||||
.. |relaxedCamelCase_value| replace::
|
||||
:code:`relaxedCamelCase`
|
||||
|
||||
.. |PascalCase_value| replace::
|
||||
:code:`PascalCase`
|
||||
|
||||
.. |RelaxedPascalCase_value| replace::
|
||||
:code:`RelaxedPascalCase`
|
||||
|
||||
.. |PascalSnakeCase_value| replace::
|
||||
:code:`Pascal_Snake_Case`
|
||||
|
||||
.. |regex_value| replace::
|
||||
:code:`regex`
|
||||
|
||||
|
|
@ -48,25 +39,16 @@ There are several options to these rules:
|
|||
|upper_or_lower_value| = Allow upper or lower case
|
||||
|
||||
.. |case_option__camelCase| replace::
|
||||
|camelCase_value| = Enforce camelCase with two allowed uppercase characters in a row
|
||||
|
||||
.. |case_option__relaxedCamelCase| replace::
|
||||
|relaxedCamelCase_value| = Enforce camelCase with any number of uppercase characters in a row
|
||||
|camelCase_value| = Enforce camelCase
|
||||
|
||||
.. |case_option__PascalCase| replace::
|
||||
|PascalCase_value| = Enforce PascalCase with two allowed uppercase characters in a row
|
||||
|
||||
.. |case_option__RelaxedPascalCase| replace::
|
||||
|RelaxedPascalCase_value| = Enforce PascalCase with any number of uppercase characters in a row
|
||||
|
||||
.. |case_option__PascalSnakeCase| replace::
|
||||
|PascalSnakeCase_value| = Enforce Pascal_Snake_Case
|
||||
|PascalCase_value| = Enforce PascalCase
|
||||
|
||||
.. |case_option__regex| replace::
|
||||
|regex_value| = Enforce user defined regex
|
||||
|
||||
.. |case_values| replace::
|
||||
|upper_value|, |lower_value|, |upper_or_lower_value|, |camelCase_value|, |relaxedCamelCase_value|, |PascalCase_value|, |RelaxedPascalCase_value|, |regex_value|
|
||||
|upper_value|, |lower_value|, |upper_or_lower_value|, |camelCase_value|, |PascalCase_value|, |regex_value|
|
||||
|
||||
.. |case_default_value| replace::
|
||||
|lower_value|
|
||||
|
|
@ -119,27 +101,24 @@ There are several options to these rules:
|
|||
.. |regex_description| replace::
|
||||
Enforce case based on regex string
|
||||
|
||||
+----------------------------+---------------------------+-----------------------+------------------------------------+
|
||||
| Option | Values | Default Value | Description |
|
||||
+============================+===========================+=======================+====================================+
|
||||
| |case_option| | |upper_value| | |case_default_value| | * |case_option__upper| |
|
||||
| | |lower_value| | | * |case_option__lower| |
|
||||
| | |upper_or_lower_value| | | * |case_option__upper_or_lower| |
|
||||
| | |camelCase_value| | | * |case_option__camelCase| |
|
||||
| | |relaxedCamelCase_value| | | * |case_option__relaxedCamelCase| |
|
||||
| | |PascalCase_value| | | * |case_option__PascalCase| |
|
||||
| | |RelaxedPascalCase_value| | | * |case_option__RelaxedPascalCase| |
|
||||
| | |PascalSnakeCase_value| | | * |case_option__PascalSnakeCase| |
|
||||
| | |regex_value| | | * |case_option__regex| |
|
||||
+----------------------------+---------------------------+-----------------------+------------------------------------+
|
||||
| |prefix_exceptions_option| | |pe_values| | |pe_default_value| | |pe_description| |
|
||||
+----------------------------+---------------------------+-----------------------+------------------------------------+
|
||||
| |suffix_exceptions_option| | |se_values| | |se_default_value| | |se_description| |
|
||||
+----------------------------+---------------------------+-----------------------+------------------------------------+
|
||||
| |case_exceptions_option| | |ce_values| | |ce_default_value| | |ce_description| |
|
||||
+----------------------------+---------------------------+-----------------------+------------------------------------+
|
||||
| |regex_option| | |regex_values| | |regex_default_value| | |regex_description| |
|
||||
+----------------------------+---------------------------+-----------------------+------------------------------------+
|
||||
+----------------------------+------------------------+-----------------------+-----------------------------------+
|
||||
| Option | Values | Default Value | Description |
|
||||
+============================+========================+=======================+===================================+
|
||||
| |case_option| | |case_values| | |case_default_value| | * |case_option__upper| |
|
||||
| | | | * |case_option__lower| |
|
||||
| | | | * |case_option__upper_or_lower| |
|
||||
| | | | * |case_option__camelCase| |
|
||||
| | | | * |case_option__PascalCase| |
|
||||
| | | | * |case_option__regex| |
|
||||
+----------------------------+------------------------+-----------------------+-----------------------------------+
|
||||
| |prefix_exceptions_option| | |pe_values| | |pe_default_value| | |pe_description| |
|
||||
+----------------------------+------------------------+-----------------------+-----------------------------------+
|
||||
| |suffix_exceptions_option| | |se_values| | |se_default_value| | |se_description| |
|
||||
+----------------------------+------------------------+-----------------------+-----------------------------------+
|
||||
| |case_exceptions_option| | |ce_values| | |ce_default_value| | |ce_description| |
|
||||
+----------------------------+------------------------+-----------------------+-----------------------------------+
|
||||
| |regex_option| | |regex_values| | |regex_default_value| | |regex_description| |
|
||||
+----------------------------+------------------------+-----------------------+-----------------------------------+
|
||||
|
||||
This is an example of how to configure these options.
|
||||
|
||||
|
|
@ -242,7 +221,7 @@ For example, if you want to uppercase everything except the entity name, you cou
|
|||
Rules Enforcing Case
|
||||
####################
|
||||
|
||||
* `after_500 <after_rules.html#after-500>`_
|
||||
* `aggregate_500 <aggregate_rules.html#aggregate-500>`_
|
||||
|
||||
* `alias_declaration_500 <alias_declaration_rules.html#alias-declaration-500>`_
|
||||
* `alias_declaration_501 <alias_declaration_rules.html#alias-declaration-501>`_
|
||||
|
|
@ -258,8 +237,6 @@ Rules Enforcing Case
|
|||
* `architecture_021 <architecture_rules.html#architecture-021>`_
|
||||
* `architecture_028 <architecture_rules.html#architecture-028>`_
|
||||
|
||||
* `array_constraint_500 <../array_constraint_rules.html#array-constraint-500>`_
|
||||
|
||||
* `assert_500 <assert_rules.html#assert-500>`_
|
||||
* `assert_501 <assert_rules.html#assert-501>`_
|
||||
* `assert_502 <assert_rules.html#assert-502>`_
|
||||
|
|
@ -291,14 +268,14 @@ Rules Enforcing Case
|
|||
* `case_016 <case_rules.html#case-016>`_
|
||||
* `case_017 <case_rules.html#case-017>`_
|
||||
* `case_018 <case_rules.html#case-018>`_
|
||||
* `case_500 <case_rules.html#case-500>`_
|
||||
|
||||
* `case_generate_alternative_500 <case_generate_alternative_rules.html#case-generate-alternative-500>`_
|
||||
* `case_generate_alternative_501 <case_generate_alternative_rules.html#case-generate-alternative-501>`_
|
||||
|
||||
* `case_generate_statement_500 <case_generate_statement_rules.html#case-generate-statement-500>`_
|
||||
* `case_generate_statement_501 <case_generate_statement_rules.html#case-generate-statement-501>`_
|
||||
|
||||
* `choice_500 <choice_rules.html#choice-500>`_
|
||||
|
||||
* `component_004 <component_rules.html#component-004>`_
|
||||
* `component_006 <component_rules.html#component-006>`_
|
||||
* `component_008 <component_rules.html#component-008>`_
|
||||
|
|
@ -315,9 +292,6 @@ Rules Enforcing Case
|
|||
* `constant_002 <constant_rules.html#constant-002>`_
|
||||
* `constant_004 <constant_rules.html#constant-004>`_
|
||||
|
||||
* `constrained_array_definition_500 <constrained_array_definition_rules.html#constrained-array-definition-500>`_
|
||||
* `constrained_array_definition_501 <constrained_array_definition_rules.html#constrained-array-definition-501>`_
|
||||
|
||||
* `context_004 <context_rules.html#context-004>`_
|
||||
* `context_012 <context_rules.html#context-012>`_
|
||||
* `context_013 <context_rules.html#context-013>`_
|
||||
|
|
@ -329,10 +303,6 @@ Rules Enforcing Case
|
|||
* `context_ref_500 <context_ref_rules.html#context-ref-500>`_
|
||||
* `context_ref_501 <context_ref_rules.html#context-ref-501>`_
|
||||
|
||||
* `delay_mechanism_500 <delay_mechanism_rules.html#delay-mechanism-500>`_
|
||||
* `delay_mechanism_501 <delay_mechanism_rules.html#delay-mechanism-501>`_
|
||||
* `delay_mechanism_502 <delay_mechanism_rules.html#delay-mechanism-502>`_
|
||||
|
||||
* `entity_004 <entity_rules.html#entity-004>`_
|
||||
* `entity_006 <entity_rules.html#entity-006>`_
|
||||
* `entity_008 <entity_rules.html#entity-008>`_
|
||||
|
|
@ -350,28 +320,22 @@ Rules Enforcing Case
|
|||
|
||||
* `exponent_500 <exponent_rules.html#exponent-500>`_
|
||||
|
||||
* `external_constant_name_500 <external_constant_name_rules.html#external-constant-name-500>`_
|
||||
* `external_constant_name_500 <../external_constant_name_rules.html#external-constant-name-500>`_
|
||||
|
||||
* `external_signal_name_500 <external_signal_name_rules.html#external-signal-name-500>`_
|
||||
* `external_signal_name_500 <../external_signal_name_rules.html#external-signal-name-500>`_
|
||||
|
||||
* `external_variable_name_500 <external_variable_name_rules.html#external-variable-name-500>`_
|
||||
|
||||
* `file_open_information_500 <file_open_information_rules.html#file-open-information-500>`_
|
||||
* `file_open_information_501 <file_open_information_rules.html#file-open-information-501>`_
|
||||
* `file_open_information_502 <file_open_information_rules.html#file-open-information-502>`_
|
||||
* `external_variable_name_500 <../external_variable_name_rules.html#external-variable-name-500>`_
|
||||
|
||||
* `file_002 <file_rules.html#file-002>`_
|
||||
* `file_500 <file_rules.html#file-500>`_
|
||||
|
||||
* `file_type_definition_500 <file_type_definition_rules.html#file-type-definition-500>`_
|
||||
* `file_type_definition_501 <file_type_definition_rules.html#file-type-definition-501>`_
|
||||
|
||||
* `for_generate_statement_500 <for_generate_statement_rules.html#for-generate-statement-500>`_
|
||||
* `for_generate_statement_501 <for_generate_statement_rules.html#for-generate-statement-501>`_
|
||||
* `for_generate_statement_502 <for_generate_statement_rules.html#for-generate-statement-502>`_
|
||||
|
||||
* `function_004 <function_rules.html#function-004>`_
|
||||
* `function_005 <function_rules.html#function-005>`_
|
||||
* `function_013 <function_rules.html#function-013>`_
|
||||
* `function_014 <function_rules.html#function-014>`_
|
||||
* `function_017 <function_rules.html#function-017>`_
|
||||
* `function_501 <function_rules.html#function-501>`_
|
||||
* `function_502 <function_rules.html#function-502>`_
|
||||
|
|
@ -391,10 +355,13 @@ Rules Enforcing Case
|
|||
|
||||
* `generic_007 <generic_rules.html#generic-007>`_
|
||||
* `generic_009 <generic_rules.html#generic-009>`_
|
||||
* `generic_017 <generic_rules.html#generic-017>`_
|
||||
|
||||
* `generic_map_001 <generic_map_rules.html#generic-map-001>`_
|
||||
* `generic_map_002 <generic_map_rules.html#generic-map-002>`_
|
||||
|
||||
* `ieee_500 <ieee_rules.html#ieee-500>`_
|
||||
|
||||
* `if_generate_statement_500 <if_generate_statement_rules.html#if-generate-statement-500>`_
|
||||
* `if_generate_statement_501 <if_generate_statement_rules.html#if-generate-statement-501>`_
|
||||
* `if_generate_statement_502 <if_generate_statement_rules.html#if-generate-statement-502>`_
|
||||
|
|
@ -407,8 +374,6 @@ Rules Enforcing Case
|
|||
* `if_029 <if_rules.html#if-029>`_
|
||||
* `if_034 <if_rules.html#if-034>`_
|
||||
|
||||
* `index_subtype_definition_500 <index_subtype_definition_rules.html#index-subtype-definition-500>`_
|
||||
|
||||
* `instantiation_008 <instantiation_rules.html#instantiation-008>`_
|
||||
* `instantiation_009 <instantiation_rules.html#instantiation-009>`_
|
||||
* `instantiation_027 <instantiation_rules.html#instantiation-027>`_
|
||||
|
|
@ -416,11 +381,9 @@ Rules Enforcing Case
|
|||
* `instantiation_031 <instantiation_rules.html#instantiation-031>`_
|
||||
* `instantiation_500 <instantiation_rules.html#instantiation-500>`_
|
||||
|
||||
* `interface_incomplete_type_declaration_500 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-500>`_
|
||||
* `interface_incomplete_type_declaration_501 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-501>`_
|
||||
|
||||
* `iteration_scheme_500 <iteration_scheme_rules.html#iteration-scheme-500>`_
|
||||
* `iteration_scheme_501 <iteration_scheme_rules.html#iteration-scheme-501>`_
|
||||
* `iteration_scheme_502 <iteration_scheme_rules.html#iteration-scheme-502>`_
|
||||
|
||||
* `library_004 <library_rules.html#library-004>`_
|
||||
* `library_005 <library_rules.html#library-005>`_
|
||||
|
|
@ -455,28 +418,22 @@ Rules Enforcing Case
|
|||
* `package_body_506 <package_body_rules.html#package-body-506>`_
|
||||
* `package_body_507 <package_body_rules.html#package-body-507>`_
|
||||
|
||||
* `package_instantiation_500 <package_instantiation_rules.html#package-instantiation-500>`_
|
||||
* `package_instantiation_501 <package_instantiation_rules.html#package-instantiation-501>`_
|
||||
* `package_instantiation_502 <package_instantiation_rules.html#package-instantiation-502>`_
|
||||
* `package_instantiation_503 <package_instantiation_rules.html#package-instantiation-503>`_
|
||||
* `package_instantiation_504 <package_instantiation_rules.html#package-instantiation-504>`_
|
||||
|
||||
* `parameter_specification_500 <parameter_specification_rules.html#parameter-specification-500>`_
|
||||
* `parameter_specification_501 <parameter_specification_rules.html#parameter-specification-501>`_
|
||||
|
||||
* `port_010 <port_rules.html#port-010>`_
|
||||
* `port_017 <port_rules.html#port-017>`_
|
||||
* `port_018 <port_rules.html#port-018>`_
|
||||
* `port_019 <port_rules.html#port-019>`_
|
||||
|
||||
* `port_map_001 <port_map_rules.html#port-map-001>`_
|
||||
* `port_map_002 <port_map_rules.html#port-map-002>`_
|
||||
|
||||
* `procedure_008 <procedure_rules.html#procedure-008>`_
|
||||
* `procedure_009 <procedure_rules.html#procedure-009>`_
|
||||
* `procedure_500 <procedure_rules.html#procedure-500>`_
|
||||
* `procedure_501 <procedure_rules.html#procedure-501>`_
|
||||
* `procedure_502 <procedure_rules.html#procedure-502>`_
|
||||
* `procedure_503 <procedure_rules.html#procedure-503>`_
|
||||
* `procedure_504 <procedure_rules.html#procedure-504>`_
|
||||
* `procedure_505 <procedure_rules.html#procedure-505>`_
|
||||
* `procedure_506 <procedure_rules.html#procedure-506>`_
|
||||
* `procedure_508 <procedure_rules.html#procedure-508>`_
|
||||
* `procedure_510 <procedure_rules.html#procedure-510>`_
|
||||
|
|
@ -504,8 +461,6 @@ Rules Enforcing Case
|
|||
* `protected_type_body_503 <protected_type_rules.html#protected-type-body-503>`_
|
||||
* `protected_type_body_504 <protected_type_rules.html#protected-type-body-504>`_
|
||||
|
||||
* `range_constraint_500 <../range_constraint_rules.html#range-constraint-500>`_
|
||||
|
||||
* `range_001 <range_rules.html#range-001>`_
|
||||
* `range_002 <range_rules.html#range-002>`_
|
||||
|
||||
|
|
@ -523,33 +478,18 @@ Rules Enforcing Case
|
|||
* `selected_assignment_502 <selected_assignment_rules.html#selected-assignment-502>`_
|
||||
* `selected_assignment_503 <selected_assignment_rules.html#selected-assignment-503>`_
|
||||
|
||||
* `shift_operator_500 <shift_operator_rules.html#shift-operator-500>`_
|
||||
|
||||
* `signal_002 <signal_rules.html#signal-002>`_
|
||||
* `signal_004 <signal_rules.html#signal-004>`_
|
||||
|
||||
* `subprogram_instantiation_500 <subprogram_instantiation_rules.html#subprogram-instantiation-500>`_
|
||||
* `subprogram_instantiation_501 <subprogram_instantiation_rules.html#subprogram-instantiation-501>`_
|
||||
* `subprogram_instantiation_502 <subprogram_instantiation_rules.html#subprogram-instantiation-502>`_
|
||||
* `subprogram_instantiation_503 <subprogram_instantiation_rules.html#subprogram-instantiation-503>`_
|
||||
|
||||
* `subprogram_kind_500 <subprogram_kind_rules.html#subprogram-kind-500>`_
|
||||
* `subprogram_kind_501 <subprogram_kind_rules.html#subprogram-kind-501>`_
|
||||
|
||||
* `subtype_500 <subtype_rules.html#subtype-500>`_
|
||||
* `subtype_501 <subtype_rules.html#subtype-501>`_
|
||||
* `subtype_502 <subtype_rules.html#subtype-502>`_
|
||||
* `subtype_500 <../subtype_rules.html#subtype-500>`_
|
||||
* `subtype_501 <../subtype_rules.html#subtype-501>`_
|
||||
* `subtype_502 <../subtype_rules.html#subtype-502>`_
|
||||
|
||||
* `type_002 <type_rules.html#type-002>`_
|
||||
* `type_004 <type_rules.html#type-004>`_
|
||||
* `type_013 <type_rules.html#type-013>`_
|
||||
* `type_500 <type_rules.html#type-500>`_
|
||||
|
||||
* `type_mark_500 <type_mark_rules.html#type-mark-500>`_
|
||||
|
||||
* `unbounded_array_definition_500 <unbounded_array_definition_rules.html#unbounded-array-definition-500>`_
|
||||
* `unbounded_array_definition_501 <unbounded_array_definition_rules.html#unbounded-array-definition-501>`_
|
||||
|
||||
* `use_clause_500 <use_clause_rules.html#use-clause-500>`_
|
||||
* `use_clause_501 <use_clause_rules.html#use-clause-501>`_
|
||||
* `use_clause_502 <use_clause_rules.html#use-clause-502>`_
|
||||
|
|
@ -557,7 +497,6 @@ Rules Enforcing Case
|
|||
|
||||
* `variable_002 <variable_rules.html#variable-002>`_
|
||||
* `variable_004 <variable_rules.html#variable-004>`_
|
||||
* `variable_500 <variable_rules.html#variable-500>`_
|
||||
|
||||
* `wait_500 <wait_rules.html#wait-500>`_
|
||||
* `wait_501 <wait_rules.html#wait-501>`_
|
||||
|
|
|
|||
|
|
@ -1,79 +0,0 @@
|
|||
.. _configuring-user-error-messages:
|
||||
|
||||
Configuring User Error Messages
|
||||
-------------------------------
|
||||
|
||||
There is an option to provide additional information to the user when a violation is found.
|
||||
This is accomplished by using the :code:`user_error_message` option.
|
||||
Setting this option for a rule will append the message to the normal output.
|
||||
|
||||
Example without :code:`user_error_message` defined
|
||||
##################################################
|
||||
|
||||
Applying a custom regex does not provide additional information to the user.
|
||||
|
||||
Given the following configuration file which defines a custom regex:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
rule:
|
||||
group:
|
||||
case::name:
|
||||
case: regex
|
||||
regex: (?![a-z||0-9]\u005F)(?!.*\u005F[a-z||0-9]$)([a-z||0-9]+(?:\u005F[a-z||0-9]+)*)
|
||||
|
||||
The following error report is generated:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$vsg -f original.vhd -c config.yaml
|
||||
================================================================================
|
||||
File: original.vhd
|
||||
================================================================================
|
||||
Phase 6 of 7... Reporting
|
||||
Total Rules Checked: 857
|
||||
Total Violations: 2
|
||||
Error : 2
|
||||
Warning : 0
|
||||
-------------+------------+------------+--------------------------------------
|
||||
Rule | severity | line(s) | Solution
|
||||
-------------+------------+------------+--------------------------------------
|
||||
entity_008 | Error | 2 | Format FIFO to match defined regex
|
||||
entity_012 | Error | 3 | Format FIFO to match defined regex
|
||||
-------------+------------+------------+--------------------------------------
|
||||
NOTE: Refer to online documentation at https://vhdl-style-guide.readthedocs.io/en/latest/index.html for more information.
|
||||
|
||||
Example with :code:`user_error_message` defined
|
||||
###############################################
|
||||
|
||||
Adding a custom error message can provide additional information to the user:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
rule:
|
||||
group:
|
||||
case::name:
|
||||
case: regex
|
||||
regex: (?![a-z||0-9]\u005F)(?!.*\u005F[a-z||0-9]$)([a-z||0-9]+(?:\u005F[a-z||0-9]+)*)
|
||||
user_error_message: "UPPERCASE and single letter prefix/suffix not allowed"
|
||||
|
||||
The following error report is generated:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$vsg -f original.vhd -c config.yaml
|
||||
================================================================================
|
||||
File: original.vhd
|
||||
================================================================================
|
||||
Phase 6 of 7... Reporting
|
||||
Total Rules Checked: 857
|
||||
Total Violations: 2
|
||||
Error : 2
|
||||
Warning : 0
|
||||
-------------+------------+------------+--------------------------------------
|
||||
Rule | severity | line(s) | Solution
|
||||
-------------+------------+------------+--------------------------------------
|
||||
entity_008 | Error | 2 | Format FIFO to match defined regex [user_error_message: UPPERCASE and single letter prefix/suffix not allowed]
|
||||
entity_012 | Error | 3 | Format FIFO to match defined regex [user_error_message: UPPERCASE and single letter prefix/suffix not allowed]
|
||||
-------------+------------+------------+--------------------------------------
|
||||
NOTE: Refer to online documentation at https://vhdl-style-guide.readthedocs.io/en/latest/index.html for more information.
|
||||
|
|
@ -28,14 +28,11 @@ These rules provide the following options:
|
|||
.. |standard__2008| replace::
|
||||
:code:`2008` = Use reserved keywords from 2008 standard
|
||||
|
||||
.. |standard__2019| replace::
|
||||
:code:`2019` = Use reserved keywords from 2019 standard
|
||||
|
||||
.. |standard__all| replace::
|
||||
:code:`all` = Use reserved keywords from all standards
|
||||
|
||||
.. |values| replace::
|
||||
:code:`1987`, :code:`1993`, :code:`2000`, :code:`2002`, :code:`2008`, :code:`2019`
|
||||
:code:`1987`, :code:`1993`, :code:`2000`, :code:`2002`, :code:`2008`
|
||||
|
||||
.. |default_value| replace::
|
||||
:code:`all`
|
||||
|
|
@ -48,7 +45,6 @@ These rules provide the following options:
|
|||
| | | | * |standard__2000| |
|
||||
| | | | * |standard__2002| |
|
||||
| | | | * |standard__2008| |
|
||||
| | | | * |standard__2019| |
|
||||
| | | | * |standard__all| |
|
||||
+----------------------+----------+-----------------+----------------------------+
|
||||
|
||||
|
|
@ -100,19 +96,6 @@ The :code:`context` keyword is a reserved word in the 2008 standard.
|
|||
end entity;
|
||||
|
||||
|
||||
Example: |standard_option| set to :code:`2019`
|
||||
##############################################
|
||||
|
||||
The :code:`private` keyword is a reserved word in the 2019 standard.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
entity private is
|
||||
end entity;
|
||||
|
||||
|
||||
Rules Enforcing Optional Items
|
||||
##############################
|
||||
|
||||
|
|
|
|||
|
|
@ -122,7 +122,6 @@ Rules Enforcing Whitespace
|
|||
* `architecture_031 <architecture_rules.html#architecture-031>`_
|
||||
* `architecture_032 <architecture_rules.html#architecture-032>`_
|
||||
* `architecture_033 <architecture_rules.html#architecture-033>`_
|
||||
* `array_constraint_100 <array_constraint_rules.html#array-constraint-100>`_
|
||||
* `assert_100 <assert_rules.html#assert-100>`_
|
||||
* `assert_101 <assert_rules.html#assert-101>`_
|
||||
* `assert_102 <assert_rules.html#assert-102>`_
|
||||
|
|
@ -137,10 +136,6 @@ Rules Enforcing Whitespace
|
|||
* `case_004 <case_rules.html#case-004>`_
|
||||
* `case_005 <case_rules.html#case-005>`_
|
||||
* `case_006 <case_rules.html#case-006>`_
|
||||
* `case_generate_alternative_100 <case_generate_alternative_rules.html#case-generate-alternative-100>`_
|
||||
* `case_generate_alternative_101 <case_generate_alternative_rules.html#case-generate-alternative-101>`_
|
||||
* `case_generate_statement_100 <case_generate_statement_rules.html#case-generate-statement-100>`_
|
||||
* `case_generate_statement_101 <case_generate_statement_rules.html#case-generate-statement-101>`_
|
||||
* `comment_004 <comment_rules.html#comment-004>`_
|
||||
* `component_002 <component_rules.html#component-002>`_
|
||||
* `component_007 <component_rules.html#component-007>`_
|
||||
|
|
@ -161,8 +156,6 @@ Rules Enforcing Whitespace
|
|||
* `constant_010 <constant_rules.html#constant-010>`_
|
||||
* `constant_100 <constant_rules.html#constant-100>`_
|
||||
* `constant_101 <constant_rules.html#constant-101>`_
|
||||
* `constrained_array_definition_100 <constrained_array_definition_rules.html#constrained-array-definition-100>`_
|
||||
* `constrained_array_definition_101 <constrained_array_definition_rules.html#constrained-array-definition-101>`_
|
||||
* `context_002 <context_rules.html#context-002>`_
|
||||
* `context_017 <context_rules.html#context-017>`_
|
||||
* `context_018 <context_rules.html#context-018>`_
|
||||
|
|
@ -176,27 +169,22 @@ Rules Enforcing Whitespace
|
|||
* `entity_013 <entity_rules.html#entity-013>`_
|
||||
* `entity_specification_100 <entity_specification_rules.html#entity-specification-100>`_
|
||||
* `entity_specification_101 <entity_specification_rules.html#entity-specification-101>`_
|
||||
* `external_constant_name_100 <external_constant_name_rules.html#external-constant-name-100>`_
|
||||
* `external_constant_name_101 <external_constant_name_rules.html#external-constant-name-101>`_
|
||||
* `external_constant_name_102 <external_constant_name_rules.html#external-constant-name-102>`_
|
||||
* `external_constant_name_103 <external_constant_name_rules.html#external-constant-name-103>`_
|
||||
* `external_constant_name_104 <external_constant_name_rules.html#external-constant-name-104>`_
|
||||
* `external_signal_name_100 <external_signal_name_rules.html#external-signal-name-100>`_
|
||||
* `external_signal_name_101 <external_signal_name_rules.html#external-signal-name-101>`_
|
||||
* `external_signal_name_102 <external_signal_name_rules.html#external-signal-name-102>`_
|
||||
* `external_signal_name_103 <external_signal_name_rules.html#external-signal-name-103>`_
|
||||
* `external_signal_name_104 <external_signal_name_rules.html#external-signal-name-104>`_
|
||||
* `external_variable_name_100 <external_variable_name_rules.html#external-variable-name-100>`_
|
||||
* `external_variable_name_101 <external_variable_name_rules.html#external-variable-name-101>`_
|
||||
* `external_variable_name_102 <external_variable_name_rules.html#external-variable-name-102>`_
|
||||
* `external_variable_name_103 <external_variable_name_rules.html#external-variable-name-103>`_
|
||||
* `external_variable_name_104 <external_variable_name_rules.html#external-variable-name-104>`_
|
||||
* `file_open_information_100 <file_open_information_rules.html#file-open-information-100>`_
|
||||
* `file_open_information_101 <file_open_information_rules.html#file-open-information-101>`_
|
||||
* `file_open_information_102 <file_open_information_rules.html#file-open-information-102>`_
|
||||
* `file_open_information_103 <file_open_information_rules.html#file-open-information-103>`_
|
||||
* `external_constant_name_100 <../external_constant_name_rules.html#external-constant-name-100>`_
|
||||
* `external_constant_name_101 <../external_constant_name_rules.html#external-constant-name-101>`_
|
||||
* `external_constant_name_102 <../external_constant_name_rules.html#external-constant-name-102>`_
|
||||
* `external_constant_name_103 <../external_constant_name_rules.html#external-constant-name-103>`_
|
||||
* `external_constant_name_104 <../external_constant_name_rules.html#external-constant-name-104>`_
|
||||
* `external_signal_name_100 <../external_signal_name_rules.html#external-signal-name-100>`_
|
||||
* `external_signal_name_101 <../external_signal_name_rules.html#external-signal-name-101>`_
|
||||
* `external_signal_name_102 <../external_signal_name_rules.html#external-signal-name-102>`_
|
||||
* `external_signal_name_103 <../external_signal_name_rules.html#external-signal-name-103>`_
|
||||
* `external_signal_name_104 <../external_signal_name_rules.html#external-signal-name-104>`_
|
||||
* `external_variable_name_100 <../external_variable_name_rules.html#external-variable-name-100>`_
|
||||
* `external_variable_name_101 <../external_variable_name_rules.html#external-variable-name-101>`_
|
||||
* `external_variable_name_102 <../external_variable_name_rules.html#external-variable-name-102>`_
|
||||
* `external_variable_name_103 <../external_variable_name_rules.html#external-variable-name-103>`_
|
||||
* `external_variable_name_104 <../external_variable_name_rules.html#external-variable-name-104>`_
|
||||
* `file_100 <file_rules.html#file-100>`_
|
||||
* `file_101 <file_rules.html#file-101>`_
|
||||
* `function_100 <function_rules.html#function-100>`_
|
||||
* `function_101 <function_rules.html#function-101>`_
|
||||
* `generate_002 <generate_rules.html#generate-002>`_
|
||||
|
|
@ -210,14 +198,10 @@ Rules Enforcing Whitespace
|
|||
* `generic_map_006 <generic_map_rules.html#generic-map-006>`_
|
||||
* `generic_map_007 <generic_map_rules.html#generic-map-007>`_
|
||||
* `generic_map_100 <generic_map_rules.html#generic-map-100>`_
|
||||
* `generic_map_101 <generic_map_rules.html#generic-map-101>`_
|
||||
* `if_003 <if_rules.html#if-003>`_
|
||||
* `if_004 <if_rules.html#if-004>`_
|
||||
* `if_005 <if_rules.html#if-005>`_
|
||||
* `if_015 <if_rules.html#if-015>`_
|
||||
* `index_constraint_100 <index_constraint_rules.html#index-constraint-100>`_
|
||||
* `index_subtype_definition_100 <index_subtype_definition_rules.html#index-subtype-definition-100>`_
|
||||
* `index_subtype_definition_101 <index_subtype_definition_rules.html#index-subtype-definition-101>`_
|
||||
* `instantiation_002 <instantiation_rules.html#instantiation-002>`_
|
||||
* `instantiation_003 <instantiation_rules.html#instantiation-003>`_
|
||||
* `instantiation_032 <instantiation_rules.html#instantiation-032>`_
|
||||
|
|
@ -234,18 +218,12 @@ Rules Enforcing Whitespace
|
|||
* `package_009 <package_rules.html#package-009>`_
|
||||
* `package_body_100 <package_body_rules.html#package-body-100>`_
|
||||
* `package_body_101 <package_body_rules.html#package-body-101>`_
|
||||
* `package_instantiation_100 <package_instantiation_rules.html#package-instantiation-100>`_
|
||||
* `package_instantiation_101 <package_instantiation_rules.html#package-instantiation-101>`_
|
||||
* `package_instantiation_102 <package_instantiation_rules.html#package-instantiation-102>`_
|
||||
* `package_instantiation_103 <package_instantiation_rules.html#package-instantiation-103>`_
|
||||
* `port_003 <port_rules.html#port-003>`_
|
||||
* `port_020 <port_rules.html#port-020>`_
|
||||
* `port_100 <port_rules.html#port-100>`_
|
||||
* `port_101 <port_rules.html#port-101>`_
|
||||
* `port_map_006 <port_map_rules.html#port-map-006>`_
|
||||
* `port_map_007 <port_map_rules.html#port-map-007>`_
|
||||
* `port_map_100 <port_map_rules.html#port-map-100>`_
|
||||
* `port_map_101 <port_map_rules.html#port-map-101>`_
|
||||
* `procedure_100 <procedure_rules.html#procedure-100>`_
|
||||
* `procedure_101 <procedure_rules.html#procedure-101>`_
|
||||
* `procedure_call_100 <procedure_call_rules.html#procedure-call-100>`_
|
||||
|
|
@ -255,8 +233,6 @@ Rules Enforcing Whitespace
|
|||
* `process_014 <process_rules.html#process-014>`_
|
||||
* `process_024 <process_rules.html#process-024>`_
|
||||
* `process_025 <process_rules.html#process-025>`_
|
||||
* `range_constraint_100 <range_constraint_rules.html#range-constraint-100>`_
|
||||
* `range_constraint_101 <range_constraint_rules.html#range-constraint-101>`_
|
||||
* `record_type_definition_100 <record_type_definition_rules.html#record-type-definition-100>`_
|
||||
* `record_type_definition_101 <record_type_definition_rules.html#record-type-definition-101>`_
|
||||
* `report_statement_100 <report_statement_rules.html#report-statement-100>`_
|
||||
|
|
@ -276,20 +252,12 @@ Rules Enforcing Whitespace
|
|||
* `signal_100 <signal_rules.html#signal-100>`_
|
||||
* `signal_101 <signal_rules.html#signal-101>`_
|
||||
* `signal_102 <signal_rules.html#signal-102>`_
|
||||
* `subprogram_instantiation_100 <subprogram_instantiation_rules.html#subprogram-instantiation-100>`_
|
||||
* `subprogram_instantiation_101 <subprogram_instantiation_rules.html#subprogram-instantiation-101>`_
|
||||
* `subprogram_instantiation_102 <subprogram_instantiation_rules.html#subprogram-instantiation-102>`_
|
||||
* `subprogram_instantiation_103 <subprogram_instantiation_rules.html#subprogram-instantiation-103>`_
|
||||
* `subprogram_instantiation_104 <subprogram_instantiation_rules.html#subprogram-instantiation-104>`_
|
||||
* `subtype_100 <subtype_rules.html#subtype-100>`_
|
||||
* `subtype_101 <subtype_rules.html#subtype-101>`_
|
||||
* `subtype_102 <subtype_rules.html#subtype-102>`_
|
||||
* `subtype_101 <../subtype_rules.html#subtype-101>`_
|
||||
* `subtype_102 <../subtype_rules.html#subtype-102>`_
|
||||
* `type_006 <type_rules.html#type-006>`_
|
||||
* `type_007 <type_rules.html#type-007>`_
|
||||
* `type_100 <type_rules.html#type-100>`_
|
||||
* `unbounded_array_definition_100 <unbounded_array_definition_rules.html#unbounded-array-definition-100>`_
|
||||
* `unbounded_array_definition_101 <unbounded_array_definition_rules.html#unbounded-array-definition-101>`_
|
||||
* `unbounded_array_definition_102 <unbounded_array_definition_rules.html#unbounded-array-definition-102>`_
|
||||
* `variable_005 <variable_rules.html#variable-005>`_
|
||||
* `variable_006 <variable_rules.html#variable-006>`_
|
||||
* `variable_100 <variable_rules.html#variable-100>`_
|
||||
|
|
@ -299,5 +267,3 @@ Rules Enforcing Whitespace
|
|||
* `variable_assignment_002 <variable_assignment_rules.html#variable-assignment-002>`_
|
||||
* `variable_assignment_003 <variable_assignment_rules.html#variable-assignment-003>`_
|
||||
* `whitespace_007 <whitespace_rules.html#whitespace-007>`_
|
||||
* `whitespace_102 <whitespace_rules.html#whitespace-102>`_
|
||||
* `whitespace_103 <whitespace_rules.html#whitespace-103>`_
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ This rule checks the indent of a constant declaration.
|
|||
architecture RTL of FIFO is
|
||||
|
||||
constant size : integer := 1;
|
||||
constant width : integer := 32;
|
||||
constant width : integer := 32
|
||||
|
||||
**Fix**
|
||||
|
||||
|
|
@ -26,7 +26,7 @@ This rule checks the indent of a constant declaration.
|
|||
architecture RTL of FIFO is
|
||||
|
||||
constant size : integer := 1;
|
||||
constant width : integer := 32;
|
||||
constant width : integer := 32
|
||||
|
||||
constant_002
|
||||
############
|
||||
|
|
@ -126,7 +126,7 @@ constant_007
|
|||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the **:=** is on the same line as the **constant** keyword.
|
||||
This rule checks the **:=** is on the same line at the **constant** keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
@ -144,7 +144,7 @@ This rule checks the **:=** is on the same line as the **constant** keyword.
|
|||
constant size : integer :=
|
||||
1;
|
||||
constant width : integer :=
|
||||
32;
|
||||
32
|
||||
|
||||
constant_010
|
||||
############
|
||||
|
|
@ -175,7 +175,7 @@ constant_011
|
|||
|
||||
The function of this rule has been superseded by the following rules:
|
||||
|
||||
* type_mark_500
|
||||
* ieee_500
|
||||
* subtype_002
|
||||
* type_014
|
||||
|
||||
|
|
|
|||
|
|
@ -1,88 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Constrained Array Definition Rules
|
||||
----------------------------------
|
||||
|
||||
constrained_array_definition_100
|
||||
################################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space before the **of** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array is array(1 downto 0) of unsigned;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array is array(1 downto 0) of unsigned;
|
||||
|
||||
constrained_array_definition_101
|
||||
################################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the **of** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array is array(1 downto 0) of unsigned;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array is array(1 downto 0) of unsigned;
|
||||
|
||||
constrained_array_definition_500
|
||||
################################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **array** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array is ARRAY(1 downto 0) of unsigned;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array is array(1 downto 0) of unsigned;
|
||||
|
||||
constrained_array_definition_501
|
||||
################################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **of** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array is ARRAY(1 downto 0) of unsigned;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array is array(1 downto 0) of unsigned;
|
||||
|
|
@ -196,7 +196,7 @@ context_009
|
|||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the **context** keyword is on the same line as the **end** context keyword.
|
||||
This rule checks the **context** keyword is on the same line as the end context keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
@ -217,7 +217,7 @@ context_010
|
|||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the context identifier is on the same line as the **end** context keyword.
|
||||
This rule checks the context identifier is on the same line as the end context keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
@ -335,7 +335,7 @@ context_015
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **context** keyword has proper case in the end context declaration.
|
||||
This rule checks the context keyword has proper case in the end context declaration.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
|
|||
|
|
@ -57,6 +57,8 @@ VSG was developed using a Test Driven Development (TDD) process.
|
|||
There are over 1000 tests which cover individual rules and other features of VSG.
|
||||
For each pull request, an accompanying test to validate the pull request would be appreciated.
|
||||
|
||||
Refer to `Setting up a Development Environment <setting_up_a_development_environment.html#running-unit-tests>`_ for more information on how to get started.
|
||||
|
||||
Quality Control
|
||||
###############
|
||||
|
||||
|
|
|
|||
|
|
@ -1,67 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Delay Mechanism Rules
|
||||
---------------------
|
||||
|
||||
delay_mechanism_500
|
||||
###################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **transport** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
a <= TRANSPORT 1 after 10 ns;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
a <= transport 1 after 10 ns;
|
||||
|
||||
delay_mechanism_501
|
||||
###################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **inertial** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
a <= INERTIAL 1 after 10 ns;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
a <= inertial 1 after 10 ns;
|
||||
|
||||
delay_mechanism_502
|
||||
###################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **reject** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
a <= REJECT 2ns inertial 1 after 10 ns;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
a <= reject 2ns inertial 1 after 10 ns;
|
||||
|
|
@ -61,7 +61,7 @@ Links to the icons are stored in a file named :code:`icons.rst` and is included
|
|||
The summary is a very brief description of what issue the rule is attempting to resolve.
|
||||
|
||||
If the rule has configuration options, a link to the configuration information will be given.
|
||||
The links are stored in a file named :code:`links.rst` and in included into each file using an include at the top of every file.
|
||||
The links are sored in a file named :code:`links.rst` and in included into each file using an include at the top of every file.
|
||||
|
||||
The Violation Example provides a visual indicating what the issue is.
|
||||
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ entity_003
|
|||
|
||||
|phase_3| |error| |blank_line|
|
||||
|
||||
This rule checks for blank lines or comments above the **entity** keyword.
|
||||
This rule checks for blank lines or comments above the entity keyword.
|
||||
|
||||
|configuring_previous_line_rules_link|
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ exponent_500
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **e** keyword has proper case.
|
||||
This rule checks the e keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ external_constant_name_101
|
|||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the **constant** keyword.
|
||||
This rule checks for a single space after the constant keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ external_signal_name_101
|
|||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the **signal** keyword.
|
||||
This rule checks for a single space after the signal keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ external_variable_name_101
|
|||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the **variable** keyword.
|
||||
This rule checks for a single space after the variable keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
|
|
|
|||
|
|
@ -1,175 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
File Open Information Rules
|
||||
---------------------------
|
||||
|
||||
file_open_information_100
|
||||
#########################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space before the **open** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
file_open_information_101
|
||||
#########################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the **open** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
file_open_information_102
|
||||
#########################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space before the **is** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
file_open_information_103
|
||||
#########################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the **is** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
file_open_information_500
|
||||
#########################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **open** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
file defaultImage : load_file_type OPEN read_mode is load_file_name;
|
||||
|
||||
begin
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
begin
|
||||
|
||||
file_open_information_501
|
||||
#########################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the file open kind expression has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
FILE defaultImage : load_file_type open READ_MODE is load_file_name;
|
||||
|
||||
begin
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
begin
|
||||
|
||||
file_open_information_502
|
||||
#########################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **is** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
file defaultimage : load_file_type open read_mode IS load_file_name;
|
||||
|
||||
begin
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
begin
|
||||
|
|
@ -95,53 +95,3 @@ This rule checks for a single space before the identifier.
|
|||
.. code-block:: vhdl
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
file_101
|
||||
########
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the identifier.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
file_500
|
||||
########
|
||||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks the file identifier has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
file DEFAULTIMAGE : load_file_type open read_mode is load_file_name;
|
||||
|
||||
begin
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
file defaultImage : load_file_type open read_mode is load_file_name;
|
||||
|
||||
begin
|
||||
|
|
|
|||
|
|
@ -1,56 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
File Type Definition Rules
|
||||
--------------------------
|
||||
|
||||
file_type_definition_500
|
||||
########################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **file** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type integer_file is FILE of integer;
|
||||
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
type integer_file is file of integer;
|
||||
|
||||
begin
|
||||
|
||||
file_type_definition_501
|
||||
########################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **of** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type integer_file is file OF integer;
|
||||
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture rtl of fifo is
|
||||
|
||||
type integer_file is file of integer;
|
||||
|
||||
begin
|
||||
|
|
@ -8,7 +8,7 @@ for_generate_statement_500
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **for** keyword has proper case.
|
||||
This rule checks the *for* keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
@ -29,7 +29,7 @@ for_generate_statement_501
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **generate** keyword has proper case.
|
||||
This rule checks the *generate* keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
@ -48,4 +48,20 @@ This rule checks the **generate** keyword has proper case.
|
|||
for_generate_statement_502
|
||||
##########################
|
||||
|
||||
This rule has been deprecated and replaced with rule `parameter_specification_501 <parameter_specification_rules.html#parameter-specification-501>`_.
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **in** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
gen_label : for lv_thing IN t_thing generate
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
gen_label : for lv_thing in t_thing generate
|
||||
|
|
|
|||
|
|
@ -257,7 +257,27 @@ This rule checks the **end** keyword has proper case.
|
|||
function_014
|
||||
############
|
||||
|
||||
This rule has been deprecated and replaced with rule `subprogram_kind_501 <subprogram_kind_rules.html#subprogram-kind-501>`_.
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **function** keyword in the **end function** has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end FUNCTION;
|
||||
|
||||
end Function foo;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end function;
|
||||
|
||||
end function foo;
|
||||
|
||||
function_015
|
||||
############
|
||||
|
|
@ -337,7 +357,7 @@ function_018
|
|||
|
||||
|phase_1| |error| |structure| |structure_optional|
|
||||
|
||||
This rule checks the **function** keyword exists in the closing of the function specification.
|
||||
This rule checks the function keyword exist in the closing of the function specification.
|
||||
|
||||
|configuring_optional_items_link|
|
||||
|
||||
|
|
@ -590,43 +610,6 @@ This rule checks that the parameter names have proper case.
|
|||
param2 : out integer
|
||||
) return integer;
|
||||
|
||||
function_508
|
||||
############
|
||||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks for consistent capitalization of parameter names within the subprogram body.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
function my_func (
|
||||
param1 : in integer;
|
||||
param2 : out integer
|
||||
) return integer is
|
||||
begin
|
||||
|
||||
SIG <= PARAM1 + PARAM2;
|
||||
|
||||
end function my_func;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
function my_func (
|
||||
param1 : in integer;
|
||||
param2 : out integer
|
||||
) return integer is
|
||||
begin
|
||||
|
||||
SIG <= param1 + param2;
|
||||
|
||||
end function my_func;
|
||||
|
||||
end architecture rtl;
|
||||
|
||||
function_509
|
||||
############
|
||||
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ generic_map_003
|
|||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the ( is on the same line as the **map** keyword.
|
||||
This rule checks the ( is on the same line as the **generic map** keywords.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
@ -215,35 +215,6 @@ Use explicit port mapping.
|
|||
OVERFLOW => OVERFLOW
|
||||
);
|
||||
|
||||
generic_map_009
|
||||
###############
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the **map** keyword is on the same line as the **generic** keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic
|
||||
map (
|
||||
WIDTH => 32,
|
||||
DEPTH => 512
|
||||
)
|
||||
|
||||
**Fix**
|
||||
|
||||
Use explicit port mapping.
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic map (
|
||||
|
||||
WIDTH => 32,
|
||||
DEPTH => 512
|
||||
)
|
||||
|
||||
generic_map_100
|
||||
###############
|
||||
|
||||
|
|
@ -271,114 +242,6 @@ This rules checks for whitespace before the assignment operator.
|
|||
DEPTH => 512
|
||||
);
|
||||
|
||||
generic_map_101
|
||||
###############
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between the **generic** keyword and the **map** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic map(
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic map (
|
||||
|
||||
generic_map_300
|
||||
###############
|
||||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks for the proper indentation of the **generic** keyword in generic maps.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
generic map (
|
||||
G_GEN1 => g_gen1,
|
||||
G_GEN2 => g_gen2,
|
||||
G_GEN3 => g_gen3
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
generic map (
|
||||
G_GEN1 => g_gen1,
|
||||
G_GEN2 => g_gen2,
|
||||
G_GEN3 => g_gen3
|
||||
);
|
||||
|
||||
generic_map_301
|
||||
###############
|
||||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks for the proper indentation of association elements in generic maps.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
generic map (
|
||||
G_GEN1 => g_gen1,
|
||||
G_GEN2 => g_gen2,
|
||||
G_GEN3 => g_gen3
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
generic map (
|
||||
G_GEN1 => g_gen1,
|
||||
G_GEN2 => g_gen2,
|
||||
G_GEN3 => g_gen3
|
||||
);
|
||||
|
||||
generic_map_302
|
||||
###############
|
||||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks for the proper indentation of the closing parenthesis in generic maps.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
generic map (
|
||||
G_GEN1 => g_gen1,
|
||||
G_GEN2 => g_gen2,
|
||||
G_GEN3 => g_gen3
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
generic map (
|
||||
G_GEN1 => g_gen1,
|
||||
G_GEN2 => g_gen2,
|
||||
G_GEN3 => g_gen3
|
||||
);
|
||||
|
||||
generic_map_600
|
||||
###############
|
||||
|
||||
|
|
|
|||
|
|
@ -288,9 +288,29 @@ This rule checks for multiple generics defined on a single line.
|
|||
generic_017
|
||||
###########
|
||||
|
||||
This rule was deprecated and replaced with the following rule:
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
* :ref:`type_mark_500`
|
||||
This rule checks the generic type has proper case if it is a VHDL keyword.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic (
|
||||
g_width : STD_LOGIC := '0';
|
||||
g_depth : Std_logic := '1'
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic (
|
||||
g_width : std_logic := '0';
|
||||
g_depth : std_logic := '1'
|
||||
);
|
||||
|
||||
generic_018
|
||||
###########
|
||||
|
|
|
|||
|
|
@ -1,11 +1,33 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Ieee Rules
|
||||
----------
|
||||
IEEE Rules
|
||||
-----------
|
||||
|
||||
ieee_500
|
||||
IEEE_500
|
||||
########
|
||||
|
||||
This rule was deprecated and replaced with the following rule:
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
* :ref:`type_mark_500`
|
||||
This rule checks IEEE types have the proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
port (
|
||||
WR_EN : in STD_LOGIC;
|
||||
RD_EN : in STD_logic;
|
||||
DATA : inout STD_LOGIC_VECTOR(31 downto 0)
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
port (
|
||||
WR_EN : in std_logic;
|
||||
RD_EN : in std_logic;
|
||||
DATA : inout std_logic_vector(31 downto 0)
|
||||
);
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ if_generate_statement_300
|
|||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks the indent of the **elsif** keyword.
|
||||
This rule checks the indent of the *elsif* keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
@ -31,7 +31,7 @@ if_generate_statement_301
|
|||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks the indent of the **else** keyword.
|
||||
This rule checks the indent of the *else* keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ if_generate_statement_500
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **if** keyword has proper case.
|
||||
This rule checks the *if* keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
@ -75,7 +75,7 @@ if_generate_statement_501
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **generate** keyword has proper case.
|
||||
This rule checks the *generate* keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
@ -100,7 +100,7 @@ if_generate_statement_502
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **elsif** keyword has proper case.
|
||||
This rule checks the *elsif* keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
@ -121,7 +121,7 @@ if_generate_statement_503
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **else** keyword has proper case.
|
||||
This rule checks the *else* keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
|
|||
|
|
@ -1,25 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Index Constraint Rules
|
||||
----------------------
|
||||
|
||||
index_constraint_100
|
||||
####################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for whitespace before the opening parenthesis.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype my_array3 is my_array2(open) (7 downto 0);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype my_array3 is my_array2(open)(7 downto 0);
|
||||
|
|
@ -1,67 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Index Subtype Definition Rules
|
||||
------------------------------
|
||||
|
||||
index_subtype_definition_100
|
||||
############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space before the **range** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type my_array is array (natural range <>) of integer;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type my_array is array (natural range <>) of integer;
|
||||
|
||||
index_subtype_definition_101
|
||||
############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the **range** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type my_array is array (natural range <>) of integer;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type my_array is array (natural range <>) of integer;
|
||||
|
||||
index_subtype_definition_500
|
||||
############################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **range** keyword in index subtype definitions has the proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_unsigned_array is array(natural RANGE <>) of unsigned;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_unsigned_array is array(natural range <>) of unsigned;
|
||||
|
|
@ -15,10 +15,10 @@ It can be installed using **pip**.
|
|||
|
||||
This is the preferred method for installing VSG.
|
||||
|
||||
GitHub
|
||||
------
|
||||
Git Hub
|
||||
-------
|
||||
|
||||
The latest development version can be cloned from the GitHub repo.
|
||||
The latest development version can be cloned from the git hub repo.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
|
|
|
|||
|
|
@ -6,15 +6,31 @@ Instantiation Rules
|
|||
instantiation_001
|
||||
#################
|
||||
|
||||
This rule has been split into the following rules:
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
* :ref:`instantiation_300`
|
||||
* :ref:`generic_map_300`
|
||||
* :ref:`generic_map_301`
|
||||
* :ref:`generic_map_302`
|
||||
* :ref:`port_map_300`
|
||||
* :ref:`port_map_301`
|
||||
* :ref:`port_map_302`
|
||||
This rule checks for the proper indentation of instantiations.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
port map (
|
||||
WR_EN => wr_en,
|
||||
RD_EN => rd_en,
|
||||
OVERFLOW => overflow
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
port map (
|
||||
WR_EN => wr_en,
|
||||
RD_EN => rd_en,
|
||||
OVERFLOW => overflow
|
||||
);
|
||||
|
||||
instantiation_002
|
||||
#################
|
||||
|
|
@ -256,10 +272,7 @@ This rule has been renamed to `generic_map_005 <generic_map_rules.html#generic-m
|
|||
instantiation_018
|
||||
#################
|
||||
|
||||
This rule was deprecated and replaced with rules:
|
||||
|
||||
* `generic_map_006 <generic_map_rules.html#generic-map-006>`_.
|
||||
* `port_map_006 <port_map_rules.html#port-map-006>`_.
|
||||
This rule has been renamed to `generic_map_006 <generic_map_rules.html#generic-map-006>`_.
|
||||
|
||||
instantiation_019
|
||||
#################
|
||||
|
|
@ -415,7 +428,7 @@ instantiation_031
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **component** keyword has proper case in component instantiations that use the **component** keyword.
|
||||
This rule checks the component keyword has proper case in component instantiations that use the **component** keyword.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
@ -535,60 +548,6 @@ This rule checks the semicolon is not on its own line.
|
|||
A => B,
|
||||
B => C);
|
||||
|
||||
instantiation_036
|
||||
#################
|
||||
|
||||
|phase_1| |error| |unfixable| |structure| |structure_optional|
|
||||
|
||||
This rule checks for the optional architecture specification in entity instantiations.
|
||||
|
||||
The default action is "add".
|
||||
|
||||
|configuring_optional_items_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
cmp_test : entity work.my_module;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
cmp_test : entity work.my_module(rtl);
|
||||
|
||||
instantiation_300
|
||||
#################
|
||||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks for the proper indentation of instantiations.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
count <= val;
|
||||
U_FIFO : FIFO
|
||||
port map (
|
||||
WR_EN => wr_en,
|
||||
RD_EN => rd_en,
|
||||
OVERFLOW => overflow
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
count <= val;
|
||||
U_FIFO : FIFO
|
||||
port map (
|
||||
WR_EN => wr_en,
|
||||
RD_EN => rd_en,
|
||||
OVERFLOW => overflow
|
||||
);
|
||||
|
||||
instantiation_500
|
||||
#################
|
||||
|
||||
|
|
|
|||
|
|
@ -1,100 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Interface Incomplete Type Declaration Rules
|
||||
-------------------------------------------
|
||||
|
||||
interface_incomplete_type_declaration_500
|
||||
#########################################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **type** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic (
|
||||
TYPE generic_data_type
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic (
|
||||
type generic_data_type
|
||||
|
||||
interface_incomplete_type_declaration_501
|
||||
#########################################
|
||||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks the type name has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic (
|
||||
type GENERIC_DATA_TYPE
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic (
|
||||
type generic_data_type
|
||||
|
||||
interface_incomplete_type_declaration_600
|
||||
#########################################
|
||||
|
||||
|phase_7| |disabled| |error| |unfixable| |naming|
|
||||
|
||||
This rule checks for valid prefixes of type names.
|
||||
|
||||
.. NOTE:: The default prefix is *gt_*.
|
||||
|
||||
|configuring_prefix_and_suffix_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic (
|
||||
type generic_data_type
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic (
|
||||
type gt_generic_data_type
|
||||
|
||||
interface_incomplete_type_declaration_601
|
||||
#########################################
|
||||
|
||||
|phase_7| |disabled| |error| |unfixable| |naming|
|
||||
|
||||
This rule checks for valid suffixes of type names.
|
||||
|
||||
.. NOTE:: The default prefix is *_gt*.
|
||||
|
||||
|configuring_prefix_and_suffix_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic (
|
||||
type generic_data_type
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
generic (
|
||||
type generic_data_type_gt
|
||||
|
|
@ -155,4 +155,20 @@ This rule checks the **for** keyword has proper case.
|
|||
iteration_scheme_502
|
||||
####################
|
||||
|
||||
This rule has been deprecated and replaced with rule `parameter_specification_501 <parameter_specification_rules.html#parameter-specification-501>`_.
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **in** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
for lv_thing IN t_thing loop
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
for lv_thing in t_thing loop
|
||||
|
|
|
|||
|
|
@ -275,23 +275,6 @@ This rule checks the **use** keyword is on its own line.
|
|||
context c1 is library ieee;
|
||||
use ieee.std_logic_1164.all; end context c1;
|
||||
|
||||
library_012
|
||||
###########
|
||||
|
||||
|phase_7| |disabled| |error| |unfixable| |naming|
|
||||
|
||||
This rule checks for libraries that have been restricted by the user.
|
||||
|
||||
|configuring_library_and_package_name_restriction_rules_link|
|
||||
|
||||
.. NOTE:: This rule is disabled by default.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
library bad_lib;
|
||||
|
||||
library_500
|
||||
###########
|
||||
|
||||
|
|
|
|||
|
|
@ -50,9 +50,6 @@
|
|||
.. |configuring_number_of_signals_in_signal_declaration_link| replace::
|
||||
Refer to :ref:`configuring-number-of-signals-in-signal-declaration` for more information.
|
||||
|
||||
.. |configuring_number_of_variables_in_variable_declaration_link| replace::
|
||||
Refer to :ref:`configuring-number-of-variables-in-variable-declaration` for more information.
|
||||
|
||||
.. |configuring_optional_items_link| replace::
|
||||
Refer to :ref:`configuring-optional-items` for more information.
|
||||
|
||||
|
|
@ -97,9 +94,3 @@
|
|||
|
||||
.. |configuring_port_map_new_line_link| replace::
|
||||
Refer to :ref:`configuring-port-map-new-line` for configuration options.
|
||||
|
||||
.. |configuring_comment_indenting_link| replace::
|
||||
Refer to :ref:`configuring-comment-indenting` for configuration options.
|
||||
|
||||
.. |configuring_library_and_package_name_restriction_rules_link| replace::
|
||||
Refer to :ref:`configuring-library-and-package-name-restriction-rules` for configuration options.
|
||||
|
|
|
|||
|
|
@ -64,5 +64,5 @@ Known Limitations
|
|||
VSG is a continual work in progress.
|
||||
As such, this version has the following known limitations:
|
||||
|
||||
* Minumal support for embedded PSL
|
||||
* Parser will not process embedded PSL
|
||||
* Parser will not process VHDL 2019
|
||||
|
|
|
|||
|
|
@ -208,7 +208,7 @@ package_body_300
|
|||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks the indent of the **package body** keyword.
|
||||
This rule checks the indent of the package body keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
@ -377,7 +377,7 @@ package_body_502
|
|||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks the package name has proper case in the package body declaration.
|
||||
This rule checks the package name has proper case in the package declaration.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
@ -406,13 +406,13 @@ This rule checks the **is** keyword has proper case.
|
|||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package body fifo_pkg IS
|
||||
package fifo_pkg IS
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package body fifo_pkg is
|
||||
package fifo_pkg is
|
||||
|
||||
package_body_504
|
||||
################
|
||||
|
|
@ -427,13 +427,13 @@ This rule checks the **end** keyword has proper case.
|
|||
|
||||
.. code-block:: vhdl
|
||||
|
||||
END package body fifo_pkg;
|
||||
END package fifo_pkg;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end package body fifo_pkg;
|
||||
end package fifo_pkg;
|
||||
|
||||
package_body_505
|
||||
################
|
||||
|
|
@ -482,7 +482,7 @@ package_body_507
|
|||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks the package name has proper case on the end package body declaration.
|
||||
This rule checks the package name has proper case on the end package declaration.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
@ -496,7 +496,7 @@ This rule checks the package name has proper case on the end package body declar
|
|||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end package body fifo_pkg;
|
||||
end package fifo_pkg;
|
||||
|
||||
package_body_600
|
||||
################
|
||||
|
|
|
|||
|
|
@ -1,392 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Package Instantiation Rules
|
||||
---------------------------
|
||||
|
||||
package_instantiation_001
|
||||
#########################
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the new package identifier is on the same line as the **package** keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package
|
||||
my_pkg is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_002
|
||||
#########################
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the **is** keyword is on the same line as the new package identifier.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg
|
||||
is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_003
|
||||
#########################
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the **new** keyword is on the same line as the **is** keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is
|
||||
new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_004
|
||||
#########################
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the uninstantiated package name is on the same line as the **new** keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new
|
||||
my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_100
|
||||
#########################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between the **package** keyword and the new package identifier.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_101
|
||||
#########################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between the new package identifier and the **is** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_102
|
||||
#########################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between the **is** keyword and the **new** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_103
|
||||
#########################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between **new** keyword and the uninstantiated package name.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_200
|
||||
#########################
|
||||
|
||||
|phase_3| |error| |blank_line|
|
||||
|
||||
This rule checks for blank lines or comments above the **package** keyword.
|
||||
|
||||
|configuring_previous_line_rules_link|
|
||||
|
||||
The default style is :code:`no_code`.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
library ieee;
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
library ieee;
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_201
|
||||
#########################
|
||||
|
||||
|phase_3| |error| |blank_line|
|
||||
|
||||
This rule checks for blank lines below the package instantiation.
|
||||
|
||||
|configuring_blank_lines_link|
|
||||
|
||||
The default style is :code:`no_blank_line`.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
generic map (
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
generic map (
|
||||
|
||||
package_instantiation_300
|
||||
#########################
|
||||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks the indent of the package declaration.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
library ieee;
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
library ieee;
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_500
|
||||
#########################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **package** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
PACKAGE my_pkg is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_501
|
||||
#########################
|
||||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks the instantiated package name has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package MY_PKG is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_502
|
||||
#########################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **is** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg IS new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_503
|
||||
#########################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **new** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is NEW my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_504
|
||||
#########################
|
||||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks the uninstantiated package name has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new MY_GENERIC_PKG
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package my_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_600
|
||||
#########################
|
||||
|
||||
|phase_7| |disabled| |error| |unfixable| |naming|
|
||||
|
||||
This rule checks for valid suffixes on package identifiers.
|
||||
The default package suffix is *_pkg*.
|
||||
|
||||
|configuring_prefix_and_suffix_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package foo is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package foo_pkg is new my_generic_pkg
|
||||
|
||||
package_instantiation_601
|
||||
#########################
|
||||
|
||||
|phase_7| |disabled| |error| |unfixable| |naming|
|
||||
|
||||
This rule checks for valid prefixes on instantiated package identifiers.
|
||||
The default package prefix is *pkg_*.
|
||||
|
||||
|configuring_prefix_and_suffix_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package foo is new my_generic_pkg
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
package pkg_foo is new my_generic_pkg
|
||||
|
|
@ -78,7 +78,7 @@ package_004
|
|||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **package** keyword has proper case.
|
||||
This rule checks the package keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
|
|
|||
|
|
@ -1,46 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Parameter Specification Rules
|
||||
-----------------------------
|
||||
|
||||
parameter_specification_500
|
||||
###########################
|
||||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks the parameter identifier has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
for LV_THING in t_thing loop
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
for lv_thing in t_thing loop
|
||||
|
||||
parameter_specification_501
|
||||
###########################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **in** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
for lv_thing IN t_thing loop
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
for lv_thing in t_thing loop
|
||||
|
|
@ -60,7 +60,7 @@ port_map_003
|
|||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the "(" character is on the same line as the **map** keyword.
|
||||
This rule checks the "(" character is on the same line as the **port map** keywords.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
@ -138,31 +138,6 @@ This rule checks for a port assignment on the same line as the **port map** keyw
|
|||
OVERFLOW => overflow
|
||||
);
|
||||
|
||||
port_map_006
|
||||
############
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between the **map** keyword and the (.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
port map(
|
||||
|
||||
port map (
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
port map (
|
||||
|
||||
port map (
|
||||
|
||||
port_map_007
|
||||
############
|
||||
|
||||
|
|
@ -272,37 +247,6 @@ Refer to the entity for port types, port directions and purpose.
|
|||
WR_EN => w_wr_en;
|
||||
RD_EN => w_rd_en;
|
||||
|
||||
port_map_011
|
||||
############
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the **map** keyword is on the same line as the **port** keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
port
|
||||
map (
|
||||
WR_EN => WR_EN,
|
||||
RD_EN => RD_EN,
|
||||
OVERFLOW => OVERFLOW
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
Use explicit port mapping.
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
port map (
|
||||
|
||||
WR_EN => WR_EN,
|
||||
RD_EN => RD_EN,
|
||||
OVERFLOW => OVERFLOW
|
||||
);
|
||||
|
||||
port_map_100
|
||||
############
|
||||
|
||||
|
|
@ -332,27 +276,6 @@ This rules checks for whitespace before the assignment operator.
|
|||
OVERFLOW => w_overflow
|
||||
);
|
||||
|
||||
port_map_101
|
||||
############
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between the **port** keyword and the **map** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
port map (
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
port map (
|
||||
|
||||
port_map_200
|
||||
############
|
||||
|
||||
|
|
@ -382,90 +305,3 @@ This rule checks for a blank line below the open parenthesis in a port map.
|
|||
RD_EN => w_rd_en,
|
||||
OVERFLOW => w_overflow
|
||||
);
|
||||
|
||||
port_map_300
|
||||
############
|
||||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks for the proper indentation of the **port** keyword in port maps.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
port map (
|
||||
WR_EN => wr_en,
|
||||
RD_EN => rd_en,
|
||||
OVERFLOW => overflow
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
port map (
|
||||
WR_EN => wr_en,
|
||||
RD_EN => rd_en,
|
||||
OVERFLOW => overflow
|
||||
);
|
||||
|
||||
port_map_301
|
||||
############
|
||||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks for the proper indentation of association elements in port maps.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
port map (
|
||||
WR_EN => wr_en,
|
||||
RD_EN => rd_en,
|
||||
OVERFLOW => overflow
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
port map (
|
||||
WR_EN => wr_en,
|
||||
RD_EN => rd_en,
|
||||
OVERFLOW => overflow
|
||||
);
|
||||
|
||||
port_map_302
|
||||
############
|
||||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks for the proper indentation of the closing parenthesis in port maps.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
port map (
|
||||
WR_EN => wr_en,
|
||||
RD_EN => rd_en,
|
||||
OVERFLOW => overflow
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
U_FIFO : FIFO
|
||||
port map (
|
||||
WR_EN => wr_en,
|
||||
RD_EN => rd_en,
|
||||
OVERFLOW => overflow
|
||||
);
|
||||
|
|
|
|||
|
|
@ -356,7 +356,7 @@ port_015
|
|||
|
||||
|phase_4| |error| |indent|
|
||||
|
||||
This rule checks the indent of the closing parenthesis for port clauses.
|
||||
This rule checks the indent of the closing parenthesis for port maps.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
@ -432,9 +432,34 @@ This rule checks the **port** keyword has proper case.
|
|||
port_018
|
||||
########
|
||||
|
||||
This rule was deprecated and replaced with the following rule:
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
* :ref:`type_mark_500`
|
||||
This rule checks the port type has proper case if it is a VHDL keyword.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
port (
|
||||
WR_EN : in STD_LOGIC;
|
||||
RD_EN : in std_logic;
|
||||
OVERFLOW : out t_OVERFLOW;
|
||||
DATA : inout STD_LOGIC_VECTOR(31 downto 0)
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
port (
|
||||
WR_EN : in std_logic;
|
||||
RD_EN : in std_logic;
|
||||
OVERFLOW : out t_OVERFLOW;
|
||||
DATA : inout std_logic_vector(31 downto 0)
|
||||
);
|
||||
|
||||
port_019
|
||||
########
|
||||
|
|
@ -566,7 +591,6 @@ This rule checks for missing modes in port declarations.
|
|||
WR_EN : std_logic;
|
||||
RD_EN : std_logic;
|
||||
OVERFLOW : std_logic;
|
||||
V_TEST : some_view;
|
||||
DATA : inout std_logic
|
||||
);
|
||||
|
||||
|
|
@ -578,7 +602,6 @@ This rule checks for missing modes in port declarations.
|
|||
WR_EN : in std_logic;
|
||||
RD_EN : in std_logic;
|
||||
OVERFLOW : out std_logic;
|
||||
V_TEST : view some_view;
|
||||
DATA : inout std_logic
|
||||
);
|
||||
|
||||
|
|
|
|||
|
|
@ -254,7 +254,27 @@ This rule checks the **end** keyword has proper case.
|
|||
procedure_009
|
||||
#############
|
||||
|
||||
This rule has been deprecated and replaced with rule `subprogram_kind_500 <subprogram_kind_rules.html#subprogram-kind-500>`_.
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **procedure** keyword in the **end procedure** has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end PROCEDURE;
|
||||
|
||||
end Procedure proc;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end procedure;
|
||||
|
||||
end procedure proc;
|
||||
|
||||
procedure_010
|
||||
#############
|
||||
|
|
@ -291,7 +311,7 @@ procedure_012
|
|||
|
||||
|phase_1| |error| |structure| |structure_optional|
|
||||
|
||||
This rule checks the **procedure** keyword exists in the closing of the procedure specification.
|
||||
This rule checks the procedure keyword exist in the closing of the procedure specification.
|
||||
|
||||
|configuring_optional_items_link|
|
||||
|
||||
|
|
@ -660,7 +680,23 @@ This rule checks the **end** keyword has proper case.
|
|||
procedure_505
|
||||
#############
|
||||
|
||||
This rule has been deprecated and replaced with rule `subprogram_kind_500 <subprogram_kind_rules.html#subprogram-kind-500>`_.
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **procedure** keyword in the **end procedure** has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end PROCEDURE average_samples;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end procedure average_samples;
|
||||
|
||||
procedure_506
|
||||
#############
|
||||
|
|
@ -763,41 +799,6 @@ This rule checks that the parameter names have proper case.
|
|||
param2 : out integer
|
||||
);
|
||||
|
||||
procedure_509
|
||||
#############
|
||||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks for consistent capitalization of parameter names within the subprogram body.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc (
|
||||
param1 : in integer;
|
||||
param2 : out integer
|
||||
) is
|
||||
begin
|
||||
|
||||
SIG <= PARAM1 + PARAM2;
|
||||
|
||||
end procedure my_proc;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc (
|
||||
param1 : in integer;
|
||||
param2 : out integer
|
||||
) is
|
||||
begin
|
||||
|
||||
SIG <= param1 + param2;
|
||||
|
||||
end procedure my_proc;
|
||||
|
||||
procedure_510
|
||||
#############
|
||||
|
||||
|
|
|
|||
|
|
@ -805,7 +805,7 @@ event configuration
|
|||
edge configuration
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. NOTE:: Configure this by setting the *'clock'* attribute to *'edge'*.
|
||||
.. NOTE:: Configuration this by setting the *'clock'* attribute to *'edge'*
|
||||
|
||||
.. code-block:: json
|
||||
|
||||
|
|
|
|||
|
|
@ -19,14 +19,10 @@ Follow these steps:
|
|||
|
||||
$ git push --tags origin master
|
||||
|
||||
4) Build the Wheel
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ tox -e wheel-py38
|
||||
4) Download wheel from CI action
|
||||
|
||||
5) Submit to PyPI
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ twine upload dist/wheel-py38/*
|
||||
$ twine upload dist/*
|
||||
|
|
|
|||
|
|
@ -24,87 +24,6 @@ This rule checks the indent of the end protected type body declaration.
|
|||
type flag_pt is protected body
|
||||
end protected body;
|
||||
|
||||
protected_type_body_400
|
||||
#######################
|
||||
|
||||
|phase_5| |error| |alignment|
|
||||
|
||||
This rule checks the identifiers for all declarations are aligned in the protected type body declarative region.
|
||||
|
||||
|configuring_identifier_alignment_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
variable var1 : natural;
|
||||
constant c_period : time;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
variable var1 : natural;
|
||||
constant c_period : time;
|
||||
|
||||
protected_type_body_401
|
||||
#######################
|
||||
|
||||
|phase_5| |error| |alignment|
|
||||
|
||||
This rule checks the colons are in the same column for all declarations in the protected type body declarative part.
|
||||
|
||||
|configuring_keyword_alignment_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type my_type protected body is
|
||||
|
||||
signal wr_en : std_logic;
|
||||
signal rd_en : std_logic;
|
||||
constant c_period : time;
|
||||
|
||||
end protected body;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type my_type protected body is
|
||||
|
||||
signal wr_en : std_logic;
|
||||
signal rd_en : std_logic;
|
||||
constant c_period : time;
|
||||
|
||||
end protected body;
|
||||
|
||||
protected_type_body_402
|
||||
#######################
|
||||
|
||||
|phase_5| |error| |alignment|
|
||||
|
||||
This rule checks the colons are in the same column for all attribute specifications.
|
||||
|
||||
|configuring_keyword_alignment_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
attribute mark_debug of wr_en : signal is "true";
|
||||
attribute mark_debug of almost_empty : signal is "true";
|
||||
attribute mark_debug of full : signal is "true";
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
attribute mark_debug of wr_en : signal is "true";
|
||||
attribute mark_debug of almost_empty : signal is "true";
|
||||
attribute mark_debug of full : signal is "true";
|
||||
|
||||
protected_type_body_500
|
||||
#######################
|
||||
|
||||
|
|
|
|||
|
|
@ -1,67 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Range Constraint Rules
|
||||
----------------------
|
||||
|
||||
range_constraint_100
|
||||
####################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space before the **range** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype my_range is natural range 0 to 7;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype my_range is natural range 0 to 7;
|
||||
|
||||
range_constraint_101
|
||||
####################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the **range** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype my_range is natural range 0 to 7;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype my_range is natural range 0 to 7;
|
||||
|
||||
range_constraint_500
|
||||
####################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **range** keyword in range constraints has the proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype t_range is natural RANGE 1 to 0;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
subtype t_range is natural range 1 to 0;
|
||||
|
|
@ -64,9 +64,6 @@ Rules Enforcing Alignment Rule Group
|
|||
* `process_035 <../process_rules.html#process-035>`_
|
||||
* `process_400 <../process_rules.html#process-400>`_
|
||||
* `process_401 <../process_rules.html#process-401>`_
|
||||
* `protected_type_body_400 <../protected_type_body_rules.html#protected-type-body-400>`_
|
||||
* `protected_type_body_401 <../protected_type_body_rules.html#protected-type-body-401>`_
|
||||
* `protected_type_body_402 <../protected_type_body_rules.html#protected-type-body-402>`_
|
||||
* `report_statement_400 <../report_statement_rules.html#report-statement-400>`_
|
||||
* `selected_assignment_400 <../selected_assignment_rules.html#selected-assignment-400>`_
|
||||
* `sequential_004 <../sequential_rules.html#sequential-004>`_
|
||||
|
|
@ -75,14 +72,10 @@ Rules Enforcing Alignment Rule Group
|
|||
* `sequential_402 <../sequential_rules.html#sequential-402>`_
|
||||
* `signal_012 <../signal_rules.html#signal-012>`_
|
||||
* `signal_400 <../signal_rules.html#signal-400>`_
|
||||
* `signal_401 <../signal_rules.html#signal-401>`_
|
||||
* `signal_402 <../signal_rules.html#signal-402>`_
|
||||
* `subprogram_body_400 <../subprogram_body_rules.html#subprogram-body-400>`_
|
||||
* `subprogram_body_401 <../subprogram_body_rules.html#subprogram-body-401>`_
|
||||
* `type_400 <../type_rules.html#type-400>`_
|
||||
* `variable_400 <../variable_rules.html#variable-400>`_
|
||||
* `variable_401 <../variable_rules.html#variable-401>`_
|
||||
* `variable_402 <../variable_rules.html#variable-402>`_
|
||||
* `variable_assignment_004 <../variable_assignment_rules.html#variable-assignment-004>`_
|
||||
* `variable_assignment_400 <../variable_assignment_rules.html#variable-assignment-400>`_
|
||||
* `variable_assignment_401 <../variable_assignment_rules.html#variable-assignment-401>`_
|
||||
|
|
|
|||
|
|
@ -22,9 +22,6 @@ Rules Enforcing Blank Line Rule Group
|
|||
* `case_010 <../case_rules.html#case-010>`_
|
||||
* `case_200 <../case_rules.html#case-200>`_
|
||||
* `case_201 <../case_rules.html#case-201>`_
|
||||
* `case_generate_alternative_200 <../case_generate_alternative_rules.html#case-generate-alternative-200>`_
|
||||
* `case_generate_alternative_201 <../case_generate_alternative_rules.html#case-generate-alternative-201>`_
|
||||
* `case_generate_statement_200 <../case_generate_statement_rules.html#case-generate-statement-200>`_
|
||||
* `component_003 <../component_rules.html#component-003>`_
|
||||
* `component_016 <../component_rules.html#component-016>`_
|
||||
* `component_018 <../component_rules.html#component-018>`_
|
||||
|
|
@ -66,8 +63,6 @@ Rules Enforcing Blank Line Rule Group
|
|||
* `package_body_201 <../package_body_rules.html#package-body-201>`_
|
||||
* `package_body_202 <../package_body_rules.html#package-body-202>`_
|
||||
* `package_body_203 <../package_body_rules.html#package-body-203>`_
|
||||
* `package_instantiation_200 <../package_instantiation_rules.html#package-instantiation-200>`_
|
||||
* `package_instantiation_201 <../package_instantiation_rules.html#package-instantiation-201>`_
|
||||
* `port_001 <../port_rules.html#port-001>`_
|
||||
* `port_022 <../port_rules.html#port-022>`_
|
||||
* `port_024 <../port_rules.html#port-024>`_
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ Case::Keyword Rule Group
|
|||
Rules Enforcing Case::Keyword Rule Group
|
||||
########################################
|
||||
|
||||
* `after_500 <../after_rules.html#after-500>`_
|
||||
* `aggregate_500 <../aggregate_rules.html#aggregate-500>`_
|
||||
* `alias_declaration_500 <../alias_declaration_rules.html#alias-declaration-500>`_
|
||||
* `alias_declaration_501 <../alias_declaration_rules.html#alias-declaration-501>`_
|
||||
* `architecture_004 <../architecture_rules.html#architecture-004>`_
|
||||
|
|
@ -14,7 +14,6 @@ Rules Enforcing Case::Keyword Rule Group
|
|||
* `architecture_020 <../architecture_rules.html#architecture-020>`_
|
||||
* `architecture_021 <../architecture_rules.html#architecture-021>`_
|
||||
* `architecture_028 <../architecture_rules.html#architecture-028>`_
|
||||
* `array_constraint_500 <../array_constraint_rules.html#array-constraint-500>`_
|
||||
* `assert_500 <../assert_rules.html#assert-500>`_
|
||||
* `assert_501 <../assert_rules.html#assert-501>`_
|
||||
* `assert_502 <../assert_rules.html#assert-502>`_
|
||||
|
|
@ -33,10 +32,11 @@ Rules Enforcing Case::Keyword Rule Group
|
|||
* `case_016 <../case_rules.html#case-016>`_
|
||||
* `case_017 <../case_rules.html#case-017>`_
|
||||
* `case_018 <../case_rules.html#case-018>`_
|
||||
* `case_500 <../case_rules.html#case-500>`_
|
||||
* `case_generate_alternative_500 <../case_generate_alternative_rules.html#case-generate-alternative-500>`_
|
||||
* `case_generate_alternative_501 <../case_generate_alternative_rules.html#case-generate-alternative-501>`_
|
||||
* `case_generate_statement_500 <../case_generate_statement_rules.html#case-generate-statement-500>`_
|
||||
* `case_generate_statement_501 <../case_generate_statement_rules.html#case-generate-statement-501>`_
|
||||
* `choice_500 <../choice_rules.html#choice-500>`_
|
||||
* `component_004 <../component_rules.html#component-004>`_
|
||||
* `component_006 <../component_rules.html#component-006>`_
|
||||
* `component_010 <../component_rules.html#component-010>`_
|
||||
|
|
@ -46,16 +46,11 @@ Rules Enforcing Case::Keyword Rule Group
|
|||
* `conditional_waveforms_500 <../conditional_waveforms_rules.html#conditional-waveforms-500>`_
|
||||
* `conditional_waveforms_501 <../conditional_waveforms_rules.html#conditional-waveforms-501>`_
|
||||
* `constant_002 <../constant_rules.html#constant-002>`_
|
||||
* `constrained_array_definition_500 <../constrained_array_definition_rules.html#constrained-array-definition-500>`_
|
||||
* `constrained_array_definition_501 <../constrained_array_definition_rules.html#constrained-array-definition-501>`_
|
||||
* `context_004 <../context_rules.html#context-004>`_
|
||||
* `context_013 <../context_rules.html#context-013>`_
|
||||
* `context_014 <../context_rules.html#context-014>`_
|
||||
* `context_015 <../context_rules.html#context-015>`_
|
||||
* `context_ref_003 <../context_ref_rules.html#context-ref-003>`_
|
||||
* `delay_mechanism_500 <../delay_mechanism_rules.html#delay-mechanism-500>`_
|
||||
* `delay_mechanism_501 <../delay_mechanism_rules.html#delay-mechanism-501>`_
|
||||
* `delay_mechanism_502 <../delay_mechanism_rules.html#delay-mechanism-502>`_
|
||||
* `entity_004 <../entity_rules.html#entity-004>`_
|
||||
* `entity_006 <../entity_rules.html#entity-006>`_
|
||||
* `entity_010 <../entity_rules.html#entity-010>`_
|
||||
|
|
@ -69,17 +64,14 @@ Rules Enforcing Case::Keyword Rule Group
|
|||
* `external_constant_name_500 <../external_constant_name_rules.html#external-constant-name-500>`_
|
||||
* `external_signal_name_500 <../external_signal_name_rules.html#external-signal-name-500>`_
|
||||
* `external_variable_name_500 <../external_variable_name_rules.html#external-variable-name-500>`_
|
||||
* `file_open_information_500 <../file_open_information_rules.html#file-open-information-500>`_
|
||||
* `file_open_information_501 <../file_open_information_rules.html#file-open-information-501>`_
|
||||
* `file_open_information_502 <../file_open_information_rules.html#file-open-information-502>`_
|
||||
* `file_002 <../file_rules.html#file-002>`_
|
||||
* `file_type_definition_500 <../file_type_definition_rules.html#file-type-definition-500>`_
|
||||
* `file_type_definition_501 <../file_type_definition_rules.html#file-type-definition-501>`_
|
||||
* `for_generate_statement_500 <../for_generate_statement_rules.html#for-generate-statement-500>`_
|
||||
* `for_generate_statement_501 <../for_generate_statement_rules.html#for-generate-statement-501>`_
|
||||
* `for_generate_statement_502 <../for_generate_statement_rules.html#for-generate-statement-502>`_
|
||||
* `function_004 <../function_rules.html#function-004>`_
|
||||
* `function_005 <../function_rules.html#function-005>`_
|
||||
* `function_013 <../function_rules.html#function-013>`_
|
||||
* `function_014 <../function_rules.html#function-014>`_
|
||||
* `function_501 <../function_rules.html#function-501>`_
|
||||
* `function_502 <../function_rules.html#function-502>`_
|
||||
* `function_509 <../function_rules.html#function-509>`_
|
||||
|
|
@ -91,7 +83,9 @@ Rules Enforcing Case::Keyword Rule Group
|
|||
* `generate_500 <../generate_rules.html#generate-500>`_
|
||||
* `generate_501 <../generate_rules.html#generate-501>`_
|
||||
* `generic_009 <../generic_rules.html#generic-009>`_
|
||||
* `generic_017 <../generic_rules.html#generic-017>`_
|
||||
* `generic_map_001 <../generic_map_rules.html#generic-map-001>`_
|
||||
* `ieee_500 <../ieee_rules.html#ieee-500>`_
|
||||
* `if_generate_statement_500 <../if_generate_statement_rules.html#if-generate-statement-500>`_
|
||||
* `if_generate_statement_501 <../if_generate_statement_rules.html#if-generate-statement-501>`_
|
||||
* `if_generate_statement_502 <../if_generate_statement_rules.html#if-generate-statement-502>`_
|
||||
|
|
@ -102,12 +96,11 @@ Rules Enforcing Case::Keyword Rule Group
|
|||
* `if_028 <../if_rules.html#if-028>`_
|
||||
* `if_029 <../if_rules.html#if-029>`_
|
||||
* `if_034 <../if_rules.html#if-034>`_
|
||||
* `index_subtype_definition_500 <../index_subtype_definition_rules.html#index-subtype-definition-500>`_
|
||||
* `instantiation_027 <../instantiation_rules.html#instantiation-027>`_
|
||||
* `instantiation_031 <../instantiation_rules.html#instantiation-031>`_
|
||||
* `interface_incomplete_type_declaration_500 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-500>`_
|
||||
* `iteration_scheme_500 <../iteration_scheme_rules.html#iteration-scheme-500>`_
|
||||
* `iteration_scheme_501 <../iteration_scheme_rules.html#iteration-scheme-501>`_
|
||||
* `iteration_scheme_502 <../iteration_scheme_rules.html#iteration-scheme-502>`_
|
||||
* `library_004 <../library_rules.html#library-004>`_
|
||||
* `library_005 <../library_rules.html#library-005>`_
|
||||
* `logical_operator_500 <../logical_operator_rules.html#logical-operator-500>`_
|
||||
|
|
@ -127,18 +120,17 @@ Rules Enforcing Case::Keyword Rule Group
|
|||
* `package_body_504 <../package_body_rules.html#package-body-504>`_
|
||||
* `package_body_505 <../package_body_rules.html#package-body-505>`_
|
||||
* `package_body_506 <../package_body_rules.html#package-body-506>`_
|
||||
* `package_instantiation_500 <../package_instantiation_rules.html#package-instantiation-500>`_
|
||||
* `package_instantiation_502 <../package_instantiation_rules.html#package-instantiation-502>`_
|
||||
* `package_instantiation_503 <../package_instantiation_rules.html#package-instantiation-503>`_
|
||||
* `parameter_specification_501 <../parameter_specification_rules.html#parameter-specification-501>`_
|
||||
* `port_017 <../port_rules.html#port-017>`_
|
||||
* `port_018 <../port_rules.html#port-018>`_
|
||||
* `port_019 <../port_rules.html#port-019>`_
|
||||
* `port_map_001 <../port_map_rules.html#port-map-001>`_
|
||||
* `procedure_008 <../procedure_rules.html#procedure-008>`_
|
||||
* `procedure_009 <../procedure_rules.html#procedure-009>`_
|
||||
* `procedure_500 <../procedure_rules.html#procedure-500>`_
|
||||
* `procedure_502 <../procedure_rules.html#procedure-502>`_
|
||||
* `procedure_503 <../procedure_rules.html#procedure-503>`_
|
||||
* `procedure_504 <../procedure_rules.html#procedure-504>`_
|
||||
* `procedure_505 <../procedure_rules.html#procedure-505>`_
|
||||
* `procedure_510 <../procedure_rules.html#procedure-510>`_
|
||||
* `procedure_511 <../procedure_rules.html#procedure-511>`_
|
||||
* `procedure_call_501 <../procedure_call_rules.html#procedure-call-501>`_
|
||||
|
|
@ -155,7 +147,6 @@ Rules Enforcing Case::Keyword Rule Group
|
|||
* `protected_type_body_502 <../protected_type_rules.html#protected-type-body-502>`_
|
||||
* `protected_type_body_503 <../protected_type_rules.html#protected-type-body-503>`_
|
||||
* `protected_type_body_504 <../protected_type_rules.html#protected-type-body-504>`_
|
||||
* `range_constraint_500 <../range_constraint_rules.html#range-constraint-500>`_
|
||||
* `range_001 <../range_rules.html#range-001>`_
|
||||
* `range_002 <../range_rules.html#range-002>`_
|
||||
* `record_type_definition_500 <../record_type_definition_rules.html#record-type-definition-500>`_
|
||||
|
|
@ -168,21 +159,13 @@ Rules Enforcing Case::Keyword Rule Group
|
|||
* `selected_assignment_501 <../selected_assignment_rules.html#selected-assignment-501>`_
|
||||
* `selected_assignment_502 <../selected_assignment_rules.html#selected-assignment-502>`_
|
||||
* `selected_assignment_503 <../selected_assignment_rules.html#selected-assignment-503>`_
|
||||
* `shift_operator_500 <../shift_operator_rules.html#shift-operator-500>`_
|
||||
* `signal_002 <../signal_rules.html#signal-002>`_
|
||||
* `subprogram_instantiation_501 <../subprogram_instantiation_rules.html#subprogram-instantiation-501>`_
|
||||
* `subprogram_instantiation_502 <../subprogram_instantiation_rules.html#subprogram-instantiation-502>`_
|
||||
* `subprogram_kind_500 <../subprogram_kind_rules.html#subprogram-kind-500>`_
|
||||
* `subprogram_kind_501 <../subprogram_kind_rules.html#subprogram-kind-501>`_
|
||||
* `subtype_500 <../subtype_rules.html#subtype-500>`_
|
||||
* `subtype_502 <../subtype_rules.html#subtype-502>`_
|
||||
* `type_002 <../type_rules.html#type-002>`_
|
||||
* `type_013 <../type_rules.html#type-013>`_
|
||||
* `unbounded_array_definition_500 <../unbounded_array_definition_rules.html#unbounded-array-definition-500>`_
|
||||
* `unbounded_array_definition_501 <../unbounded_array_definition_rules.html#unbounded-array-definition-501>`_
|
||||
* `use_clause_503 <../use_clause_rules.html#use-clause-503>`_
|
||||
* `variable_002 <../variable_rules.html#variable-002>`_
|
||||
* `variable_500 <../variable_rules.html#variable-500>`_
|
||||
* `wait_500 <../wait_rules.html#wait-500>`_
|
||||
* `wait_501 <../wait_rules.html#wait-501>`_
|
||||
* `wait_502 <../wait_rules.html#wait-502>`_
|
||||
|
|
|
|||
|
|
@ -22,41 +22,29 @@ Rules Enforcing Case::Name Rule Group
|
|||
* `entity_008 <../entity_rules.html#entity-008>`_
|
||||
* `entity_012 <../entity_rules.html#entity-012>`_
|
||||
* `entity_specification_503 <../entity_specification_rules.html#entity-specification-503>`_
|
||||
* `file_500 <file_rules.html#file-500>`_
|
||||
* `function_017 <../function_rules.html#function-017>`_
|
||||
* `function_506 <../function_rules.html#function-506>`_
|
||||
* `function_507 <../function_rules.html#function-507>`_
|
||||
* `function_508 <../function_rules.html#function-508>`_
|
||||
* `generic_007 <../generic_rules.html#generic-007>`_
|
||||
* `generic_map_002 <../generic_map_rules.html#generic-map-002>`_
|
||||
* `instantiation_009 <../instantiation_rules.html#instantiation-009>`_
|
||||
* `instantiation_028 <../instantiation_rules.html#instantiation-028>`_
|
||||
* `instantiation_500 <../instantiation_rules.html#instantiation-500>`_
|
||||
|
||||
* `interface_incomplete_type_declaration_501 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-501>`_
|
||||
|
||||
* `library_500 <../library_rules.html#library-500>`_
|
||||
* `package_008 <../package_rules.html#package-008>`_
|
||||
* `package_010 <../package_rules.html#package-010>`_
|
||||
* `package_body_502 <../package_body_rules.html#package-body-502>`_
|
||||
* `package_body_507 <../package_body_rules.html#package-body-507>`_
|
||||
* `package_instantiation_501 <../package_instantiation_rules.html#package-instantiation-501>`_
|
||||
* `package_instantiation_504 <../package_instantiation_rules.html#package-instantiation-504>`_
|
||||
* `parameter_specification_500 <../parameter_specification_rules.html#parameter-specification-500>`_
|
||||
* `port_010 <../port_rules.html#port-010>`_
|
||||
* `port_map_002 <../port_map_rules.html#port-map-002>`_
|
||||
* `procedure_501 <../procedure_rules.html#procedure-501>`_
|
||||
* `procedure_506 <../procedure_rules.html#procedure-506>`_
|
||||
* `procedure_508 <../procedure_rules.html#procedure-508>`_
|
||||
* `procedure_509 <../procedure_rules.html#procedure-509>`_
|
||||
* `procedure_call_502 <../procedure_call_rules.html#procedure-call-502>`_
|
||||
* `signal_004 <../signal_rules.html#signal-004>`_
|
||||
* `subprogram_instantiation_500 <../subprogram_instantiation_rules.html#subprogram-instantiation-500>`_
|
||||
* `subprogram_instantiation_503 <../subprogram_instantiation_rules.html#subprogram-instantiation-503>`_
|
||||
* `subtype_501 <../subtype_rules.html#subtype-501>`_
|
||||
* `type_004 <../type_rules.html#type-004>`_
|
||||
* `type_500 <../type_rules.html#type-500>`_
|
||||
* `type_mark_500 <../type_mark_rules.html#type-mark-500>`_
|
||||
* `use_clause_500 <../use_clause_rules.html#use-clause-500>`_
|
||||
* `use_clause_501 <../use_clause_rules.html#use-clause-501>`_
|
||||
* `use_clause_502 <../use_clause_rules.html#use-clause-502>`_
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ Case Rule Group
|
|||
Rules Enforcing Case Rule Group
|
||||
###############################
|
||||
|
||||
* `after_500 <../after_rules.html#after-500>`_
|
||||
* `aggregate_500 <../aggregate_rules.html#aggregate-500>`_
|
||||
* `alias_declaration_500 <../alias_declaration_rules.html#alias-declaration-500>`_
|
||||
* `alias_declaration_501 <../alias_declaration_rules.html#alias-declaration-501>`_
|
||||
* `alias_declaration_502 <../alias_declaration_rules.html#alias-declaration-502>`_
|
||||
|
|
@ -21,7 +21,6 @@ Rules Enforcing Case Rule Group
|
|||
* `architecture_028 <../architecture_rules.html#architecture-028>`_
|
||||
* `architecture_600 <../architecture_rules.html#architecture-600>`_
|
||||
* `architecture_601 <../architecture_rules.html#architecture-601>`_
|
||||
* `array_constraint_500 <../array_constraint_rules.html#array-constraint-500>`_
|
||||
* `assert_500 <../assert_rules.html#assert-500>`_
|
||||
* `assert_501 <../assert_rules.html#assert-501>`_
|
||||
* `assert_502 <../assert_rules.html#assert-502>`_
|
||||
|
|
@ -33,8 +32,8 @@ Rules Enforcing Case Rule Group
|
|||
* `attribute_specification_501 <../attribute_specification_rules.html#attribute-specification-501>`_
|
||||
* `attribute_specification_502 <../attribute_specification_rules.html#attribute-specification-502>`_
|
||||
* `attribute_specification_503 <../attribute_specification_rules.html#attribute-specification-503>`_
|
||||
* `bit_string_literal_500 <../bit_string_literal_rules.html#bit-string-literal-500>`_
|
||||
* `bit_string_literal_501 <../bit_string_literal_rules.html#bit-string-literal-501>`_
|
||||
* `bit_string_literal_500 <bit_string_literal_rules.html#bit-string-literal-500>`_
|
||||
* `bit_string_literal_501 <bit_string_literal_rules.html#bit-string-literal-501>`_
|
||||
* `block_500 <../block_rules.html#block-500>`_
|
||||
* `block_501 <../block_rules.html#block-501>`_
|
||||
* `block_502 <../block_rules.html#block-502>`_
|
||||
|
|
@ -47,10 +46,11 @@ Rules Enforcing Case Rule Group
|
|||
* `case_016 <../case_rules.html#case-016>`_
|
||||
* `case_017 <../case_rules.html#case-017>`_
|
||||
* `case_018 <../case_rules.html#case-018>`_
|
||||
* `case_500 <../case_rules.html#case-500>`_
|
||||
* `case_generate_alternative_500 <../case_generate_alternative_rules.html#case-generate-alternative-500>`_
|
||||
* `case_generate_alternative_501 <../case_generate_alternative_rules.html#case-generate-alternative-501>`_
|
||||
* `case_generate_statement_500 <../case_generate_statement_rules.html#case-generate-statement-500>`_
|
||||
* `case_generate_statement_501 <../case_generate_statement_rules.html#case-generate-statement-501>`_
|
||||
* `choice_500 <../choice_rules.html#choice-500>`_
|
||||
* `component_004 <../component_rules.html#component-004>`_
|
||||
* `component_006 <../component_rules.html#component-006>`_
|
||||
* `component_008 <../component_rules.html#component-008>`_
|
||||
|
|
@ -64,8 +64,6 @@ Rules Enforcing Case Rule Group
|
|||
* `constant_002 <../constant_rules.html#constant-002>`_
|
||||
* `constant_004 <../constant_rules.html#constant-004>`_
|
||||
* `constant_013 <../constant_rules.html#constant-013>`_
|
||||
* `constrained_array_definition_500 <../constrained_array_definition_rules.html#constrained-array-definition-500>`_
|
||||
* `constrained_array_definition_501 <../constrained_array_definition_rules.html#constrained-array-definition-501>`_
|
||||
* `context_004 <../context_rules.html#context-004>`_
|
||||
* `context_012 <../context_rules.html#context-012>`_
|
||||
* `context_013 <../context_rules.html#context-013>`_
|
||||
|
|
@ -75,9 +73,6 @@ Rules Enforcing Case Rule Group
|
|||
* `context_ref_003 <../context_ref_rules.html#context-ref-003>`_
|
||||
* `context_ref_500 <../context_ref_rules.html#context-ref-500>`_
|
||||
* `context_ref_501 <../context_ref_rules.html#context-ref-501>`_
|
||||
* `delay_mechanism_500 <../delay_mechanism_rules.html#delay-mechanism-500>`_
|
||||
* `delay_mechanism_501 <../delay_mechanism_rules.html#delay-mechanism-501>`_
|
||||
* `delay_mechanism_502 <../delay_mechanism_rules.html#delay-mechanism-502>`_
|
||||
* `entity_004 <../entity_rules.html#entity-004>`_
|
||||
* `entity_006 <../entity_rules.html#entity-006>`_
|
||||
* `entity_008 <../entity_rules.html#entity-008>`_
|
||||
|
|
@ -95,25 +90,20 @@ Rules Enforcing Case Rule Group
|
|||
* `external_constant_name_500 <../external_constant_name_rules.html#external-constant-name-500>`_
|
||||
* `external_signal_name_500 <../external_signal_name_rules.html#external-signal-name-500>`_
|
||||
* `external_variable_name_500 <../external_variable_name_rules.html#external-variable-name-500>`_
|
||||
* `file_open_information_500 <../file_open_information_rules.html#file-open-information-500>`_
|
||||
* `file_open_information_501 <../file_open_information_rules.html#file-open-information-501>`_
|
||||
* `file_open_information_502 <../file_open_information_rules.html#file-open-information-502>`_
|
||||
* `file_002 <../file_rules.html#file-002>`_
|
||||
* `file_500 <../file_rules.html#file-500>`_
|
||||
* `file_type_definition_500 <../file_type_definition_rules.html#file-type-definition-500>`_
|
||||
* `file_type_definition_501 <../file_type_definition_rules.html#file-type-definition-501>`_
|
||||
* `for_generate_statement_500 <../for_generate_statement_rules.html#for-generate-statement-500>`_
|
||||
* `for_generate_statement_501 <../for_generate_statement_rules.html#for-generate-statement-501>`_
|
||||
* `for_generate_statement_502 <../for_generate_statement_rules.html#for-generate-statement-502>`_
|
||||
* `function_004 <../function_rules.html#function-004>`_
|
||||
* `function_005 <../function_rules.html#function-005>`_
|
||||
* `function_010 <../function_rules.html#function-010>`_
|
||||
* `function_013 <../function_rules.html#function-013>`_
|
||||
* `function_014 <../function_rules.html#function-014>`_
|
||||
* `function_017 <../function_rules.html#function-017>`_
|
||||
* `function_501 <../function_rules.html#function-501>`_
|
||||
* `function_502 <../function_rules.html#function-502>`_
|
||||
* `function_506 <../function_rules.html#function-506>`_
|
||||
* `function_507 <../function_rules.html#function-507>`_
|
||||
* `function_508 <../function_rules.html#function-508>`_
|
||||
* `function_509 <../function_rules.html#function-509>`_
|
||||
* `function_510 <../function_rules.html#function-510>`_
|
||||
* `function_511 <../function_rules.html#function-511>`_
|
||||
|
|
@ -126,8 +116,10 @@ Rules Enforcing Case Rule Group
|
|||
* `generate_501 <../generate_rules.html#generate-501>`_
|
||||
* `generic_007 <../generic_rules.html#generic-007>`_
|
||||
* `generic_009 <../generic_rules.html#generic-009>`_
|
||||
* `generic_017 <../generic_rules.html#generic-017>`_
|
||||
* `generic_map_001 <../generic_map_rules.html#generic-map-001>`_
|
||||
* `generic_map_002 <../generic_map_rules.html#generic-map-002>`_
|
||||
* `ieee_500 <../ieee_rules.html#ieee-500>`_
|
||||
* `if_generate_statement_500 <../if_generate_statement_rules.html#if-generate-statement-500>`_
|
||||
* `if_generate_statement_501 <../if_generate_statement_rules.html#if-generate-statement-501>`_
|
||||
* `if_generate_statement_502 <../if_generate_statement_rules.html#if-generate-statement-502>`_
|
||||
|
|
@ -138,19 +130,15 @@ Rules Enforcing Case Rule Group
|
|||
* `if_028 <../if_rules.html#if-028>`_
|
||||
* `if_029 <../if_rules.html#if-029>`_
|
||||
* `if_034 <../if_rules.html#if-034>`_
|
||||
* `index_subtype_definition_500 <../index_subtype_definition_rules.html#index-subtype-definition-500>`_
|
||||
* `instantiation_008 <../instantiation_rules.html#instantiation-008>`_
|
||||
* `instantiation_009 <../instantiation_rules.html#instantiation-009>`_
|
||||
* `instantiation_027 <../instantiation_rules.html#instantiation-027>`_
|
||||
* `instantiation_028 <../instantiation_rules.html#instantiation-028>`_
|
||||
* `instantiation_031 <../instantiation_rules.html#instantiation-031>`_
|
||||
* `instantiation_500 <../instantiation_rules.html#instantiation-500>`_
|
||||
|
||||
* `interface_incomplete_type_declaration_500 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-500>`_
|
||||
* `interface_incomplete_type_declaration_501 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-501>`_
|
||||
|
||||
* `iteration_scheme_500 <../iteration_scheme_rules.html#iteration-scheme-500>`_
|
||||
* `iteration_scheme_501 <../iteration_scheme_rules.html#iteration-scheme-501>`_
|
||||
* `iteration_scheme_502 <../iteration_scheme_rules.html#iteration-scheme-502>`_
|
||||
* `library_004 <../library_rules.html#library-004>`_
|
||||
* `library_005 <../library_rules.html#library-005>`_
|
||||
* `library_500 <../library_rules.html#library-500>`_
|
||||
|
|
@ -177,28 +165,23 @@ Rules Enforcing Case Rule Group
|
|||
* `package_body_505 <../package_body_rules.html#package-body-505>`_
|
||||
* `package_body_506 <../package_body_rules.html#package-body-506>`_
|
||||
* `package_body_507 <../package_body_rules.html#package-body-507>`_
|
||||
* `package_instantiation_500 <../package_instantiation_rules.html#package-instantiation-500>`_
|
||||
* `package_instantiation_501 <../package_instantiation_rules.html#package-instantiation-501>`_
|
||||
* `package_instantiation_502 <../package_instantiation_rules.html#package-instantiation-502>`_
|
||||
* `package_instantiation_503 <../package_instantiation_rules.html#package-instantiation-503>`_
|
||||
* `package_instantiation_504 <../package_instantiation_rules.html#package-instantiation-504>`_
|
||||
* `parameter_specification_500 <../parameter_specification_rules.html#parameter-specification-500>`_
|
||||
* `parameter_specification_501 <../parameter_specification_rules.html#parameter-specification-501>`_
|
||||
* `port_010 <../port_rules.html#port-010>`_
|
||||
* `port_017 <../port_rules.html#port-017>`_
|
||||
* `port_018 <../port_rules.html#port-018>`_
|
||||
* `port_019 <../port_rules.html#port-019>`_
|
||||
* `port_map_001 <../port_map_rules.html#port-map-001>`_
|
||||
* `port_map_002 <../port_map_rules.html#port-map-002>`_
|
||||
* `procedure_008 <../procedure_rules.html#procedure-008>`_
|
||||
* `procedure_009 <../procedure_rules.html#procedure-009>`_
|
||||
* `procedure_500 <../procedure_rules.html#procedure-500>`_
|
||||
* `procedure_501 <../procedure_rules.html#procedure-501>`_
|
||||
* `procedure_502 <../procedure_rules.html#procedure-502>`_
|
||||
* `procedure_503 <../procedure_rules.html#procedure-503>`_
|
||||
* `procedure_504 <../procedure_rules.html#procedure-504>`_
|
||||
* `procedure_505 <../procedure_rules.html#procedure-505>`_
|
||||
* `procedure_506 <../procedure_rules.html#procedure-506>`_
|
||||
* `procedure_507 <../procedure_rules.html#procedure-507>`_
|
||||
* `procedure_508 <../procedure_rules.html#procedure-508>`_
|
||||
* `procedure_509 <../procedure_rules.html#procedure-509>`_
|
||||
* `procedure_510 <../procedure_rules.html#procedure-510>`_
|
||||
* `procedure_511 <../procedure_rules.html#procedure-511>`_
|
||||
* `procedure_call_500 <../procedure_call_rules.html#procedure-call-500>`_
|
||||
|
|
@ -219,7 +202,6 @@ Rules Enforcing Case Rule Group
|
|||
* `protected_type_body_502 <../protected_type_rules.html#protected-type-body-502>`_
|
||||
* `protected_type_body_503 <../protected_type_rules.html#protected-type-body-503>`_
|
||||
* `protected_type_body_504 <../protected_type_rules.html#protected-type-body-504>`_
|
||||
* `range_constraint_500 <../range_constraint_rules.html#range-constraint-500>`_
|
||||
* `range_001 <../range_rules.html#range-001>`_
|
||||
* `range_002 <../range_rules.html#range-002>`_
|
||||
* `record_type_definition_500 <../record_type_definition_rules.html#record-type-definition-500>`_
|
||||
|
|
@ -232,16 +214,9 @@ Rules Enforcing Case Rule Group
|
|||
* `selected_assignment_501 <../selected_assignment_rules.html#selected-assignment-501>`_
|
||||
* `selected_assignment_502 <../selected_assignment_rules.html#selected-assignment-502>`_
|
||||
* `selected_assignment_503 <../selected_assignment_rules.html#selected-assignment-503>`_
|
||||
* `shift_operator_500 <../shift_operator_rules.html#shift-operator-500>`_
|
||||
* `signal_002 <../signal_rules.html#signal-002>`_
|
||||
* `signal_004 <../signal_rules.html#signal-004>`_
|
||||
* `signal_014 <../signal_rules.html#signal-014>`_
|
||||
* `subprogram_instantiation_500 <../subprogram_instantiation_rules.html#subprogram-instantiation-500>`_
|
||||
* `subprogram_instantiation_501 <../subprogram_instantiation_rules.html#subprogram-instantiation-501>`_
|
||||
* `subprogram_instantiation_502 <../subprogram_instantiation_rules.html#subprogram-instantiation-502>`_
|
||||
* `subprogram_instantiation_503 <../subprogram_instantiation_rules.html#subprogram-instantiation-503>`_
|
||||
* `subprogram_kind_500 <../subprogram_kind_rules.html#subprogram-kind-500>`_
|
||||
* `subprogram_kind_501 <../subprogram_kind_rules.html#subprogram-kind-501>`_
|
||||
* `subtype_002 <../subtype_rules.html#subtype-002>`_
|
||||
* `subtype_500 <../subtype_rules.html#subtype-500>`_
|
||||
* `subtype_501 <../subtype_rules.html#subtype-501>`_
|
||||
|
|
@ -252,9 +227,6 @@ Rules Enforcing Case Rule Group
|
|||
* `type_014 <../type_rules.html#type-014>`_
|
||||
* `type_500 <../type_rules.html#type-500>`_
|
||||
* `type_501 <../type_rules.html#type-501>`_
|
||||
* `type_mark_500 <../type_mark_rules.html#type-mark-500>`_
|
||||
* `unbounded_array_definition_500 <../unbounded_array_definition_rules.html#unbounded-array-definition-500>`_
|
||||
* `unbounded_array_definition_501 <../unbounded_array_definition_rules.html#unbounded-array-definition-501>`_
|
||||
* `use_clause_500 <../use_clause_rules.html#use-clause-500>`_
|
||||
* `use_clause_501 <../use_clause_rules.html#use-clause-501>`_
|
||||
* `use_clause_502 <../use_clause_rules.html#use-clause-502>`_
|
||||
|
|
@ -262,7 +234,6 @@ Rules Enforcing Case Rule Group
|
|||
* `variable_002 <../variable_rules.html#variable-002>`_
|
||||
* `variable_004 <../variable_rules.html#variable-004>`_
|
||||
* `variable_011 <../variable_rules.html#variable-011>`_
|
||||
* `variable_500 <../variable_rules.html#variable-500>`_
|
||||
* `wait_500 <../wait_rules.html#wait-500>`_
|
||||
* `wait_501 <../wait_rules.html#wait-501>`_
|
||||
* `wait_502 <../wait_rules.html#wait-502>`_
|
||||
|
|
|
|||
|
|
@ -43,16 +43,13 @@ Rules Enforcing Indent Rule Group
|
|||
* `generic_002 <../generic_rules.html#generic-002>`_
|
||||
* `generic_004 <../generic_rules.html#generic-004>`_
|
||||
* `generic_008 <../generic_rules.html#generic-008>`_
|
||||
* `generic_map_300 <../generic_map_rules.html#generic-map-300>`_
|
||||
* `generic_map_301 <../generic_map_rules.html#generic-map-301>`_
|
||||
* `generic_map_302 <../generic_map_rules.html#generic-map-302>`_
|
||||
* `if_generate_statement_300 <../if_generate_statement_rules.html#if-generate-statement-300>`_
|
||||
* `if_generate_statement_301 <../if_generate_statement_rules.html#if-generate-statement-301>`_
|
||||
* `if_001 <../if_rules.html#if-001>`_
|
||||
* `if_012 <../if_rules.html#if-012>`_
|
||||
* `if_013 <../if_rules.html#if-013>`_
|
||||
* `if_014 <../if_rules.html#if-014>`_
|
||||
* `instantiation_300 <../instantiation_rules.html#instantiation-300>`_
|
||||
* `instantiation_001 <../instantiation_rules.html#instantiation-001>`_
|
||||
* `iteration_scheme_300 <../iteration_scheme_rules.html#iteration-scheme-300>`_
|
||||
* `iteration_scheme_301 <../iteration_scheme_rules.html#iteration-scheme-301>`_
|
||||
* `library_001 <../library_rules.html#library-001>`_
|
||||
|
|
@ -68,13 +65,9 @@ Rules Enforcing Indent Rule Group
|
|||
* `package_015 <../package_rules.html#package-015>`_
|
||||
* `package_body_300 <../package_body_rules.html#package-body-300>`_
|
||||
* `package_body_301 <../package_body_rules.html#package-body-301>`_
|
||||
* `package_instantiation_300 <../package_instantiation_rules.html#package-instantiation-300>`_
|
||||
* `port_002 <../port_rules.html#port-002>`_
|
||||
* `port_004 <../port_rules.html#port-004>`_
|
||||
* `port_015 <../port_rules.html#port-015>`_
|
||||
* `port_map_300 <../port_map_rules.html#port-map-300>`_
|
||||
* `port_map_301 <../port_map_rules.html#port-map-301>`_
|
||||
* `port_map_302 <../port_map_rules.html#port-map-302>`_
|
||||
* `pragma_300 <../pragma_rules.html#pragma-300>`_
|
||||
* `procedure_001 <../procedure_rules.html#procedure-001>`_
|
||||
* `procedure_002 <../procedure_rules.html#procedure-002>`_
|
||||
|
|
|
|||
|
|
@ -24,9 +24,6 @@ Rules Enforcing Naming Rule Group
|
|||
* `generic_map_601 <../generic_map_rules.html#generic-map-601>`_
|
||||
* `instantiation_600 <../instantiation_rules.html#instantiation-600>`_
|
||||
* `instantiation_601 <../instantiation_rules.html#instantiation-601>`_
|
||||
* `interface_incomplete_type_declaration_600 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-600>`_
|
||||
* `interface_incomplete_type_declaration_601 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-601>`_
|
||||
* `library_012 <../library_rules.html#library-012>`_
|
||||
* `loop_statement_600 <../loop_statement_rules.html#loop-statement-600>`_
|
||||
* `loop_statement_601 <../loop_statement_rules.html#loop-statement-601>`_
|
||||
* `loop_statement_602 <../loop_statement_rules.html#loop-statement-602>`_
|
||||
|
|
@ -35,8 +32,6 @@ Rules Enforcing Naming Rule Group
|
|||
* `package_017 <../package_rules.html#package-017>`_
|
||||
* `package_body_600 <../package_body_rules.html#package-body-600>`_
|
||||
* `package_body_601 <../package_body_rules.html#package-body-601>`_
|
||||
* `package_instantiation_600 <../package_instantiation_rules.html#package-instantiation-600>`_
|
||||
* `package_instantiation_601 <../package_instantiation_rules.html#package-instantiation-601>`_
|
||||
* `port_011 <../port_rules.html#port-011>`_
|
||||
* `port_025 <../port_rules.html#port-025>`_
|
||||
* `port_600 <../port_rules.html#port-600>`_
|
||||
|
|
@ -57,6 +52,5 @@ Rules Enforcing Naming Rule Group
|
|||
* `subtype_600 <../subtype_rules.html#subtype-600>`_
|
||||
* `type_015 <../type_rules.html#type-015>`_
|
||||
* `type_600 <../type_rules.html#type-600>`_
|
||||
* `use_clause_001 <../use_clause_rules.html#use-clause-001>`_
|
||||
* `variable_012 <../variable_rules.html#variable-012>`_
|
||||
* `variable_600 <../variable_rules.html#variable-600>`_
|
||||
|
|
|
|||
|
|
@ -19,7 +19,6 @@ Rules Enforcing Structure::Optional Rule Group
|
|||
* `function_020 <../function_rules.html#function-020>`_
|
||||
* `generate_011 <../generate_rules.html#generate-011>`_
|
||||
* `instantiation_033 <../instantiation_rules.html#instantiation-033>`_
|
||||
* `instantiation_036 <../instantiation_rules.html#instantiation-036>`_
|
||||
* `loop_statement_007 <../loop_statement_rules.html#loop-statement-007>`_
|
||||
* `package_007 <../package_rules.html#package-007>`_
|
||||
* `package_014 <../package_rules.html#package-014>`_
|
||||
|
|
|
|||
|
|
@ -80,7 +80,6 @@ Rules Enforcing Structure Rule Group
|
|||
* `generic_map_004 <../generic_map_rules.html#generic-map-004>`_
|
||||
* `generic_map_005 <../generic_map_rules.html#generic-map-005>`_
|
||||
* `generic_map_008 <../generic_map_rules.html#generic-map-008>`_
|
||||
* `generic_map_009 <../generic_map_rules.html#generic-map-009>`_
|
||||
* `if_002 <../if_rules.html#if-002>`_
|
||||
* `if_020 <../if_rules.html#if-020>`_
|
||||
* `if_021 <../if_rules.html#if-021>`_
|
||||
|
|
@ -94,7 +93,6 @@ Rules Enforcing Structure Rule Group
|
|||
* `instantiation_033 <../instantiation_rules.html#instantiation-033>`_
|
||||
* `instantiation_034 <../instantiation_rules.html#instantiation-034>`_
|
||||
* `instantiation_035 <../instantiation_rules.html#instantiation-035>`_
|
||||
* `instantiation_036 <../instantiation_rules.html#instantiation-036>`_
|
||||
* `library_010 <../library_rules.html#library-010>`_
|
||||
* `library_011 <../library_rules.html#library-011>`_
|
||||
* `loop_statement_001 <../loop_statement_rules.html#loop-statement-001>`_
|
||||
|
|
@ -110,10 +108,6 @@ Rules Enforcing Structure Rule Group
|
|||
* `package_body_001 <../package_body_rules.html#package-body-001>`_
|
||||
* `package_body_002 <../package_body_rules.html#package-body-002>`_
|
||||
* `package_body_003 <../package_body_rules.html#package-body-003>`_
|
||||
* `package_instantiation_001 <../package_instantiation_rules.html#package-instantiation-001>`_
|
||||
* `package_instantiation_002 <../package_instantiation_rules.html#package-instantiation-002>`_
|
||||
* `package_instantiation_003 <../package_instantiation_rules.html#package-instantiation-003>`_
|
||||
* `package_instantiation_004 <../package_instantiation_rules.html#package-instantiation-004>`_
|
||||
* `port_012 <../port_rules.html#port-012>`_
|
||||
* `port_013 <../port_rules.html#port-013>`_
|
||||
* `port_014 <../port_rules.html#port-014>`_
|
||||
|
|
@ -128,7 +122,6 @@ Rules Enforcing Structure Rule Group
|
|||
* `port_map_008 <../port_map_rules.html#port-map-008>`_
|
||||
* `port_map_009 <../port_map_rules.html#port-map-009>`_
|
||||
* `port_map_010 <../port_map_rules.html#port-map-010>`_
|
||||
* `port_map_011 <../port_map_rules.html#port-map-011>`_
|
||||
* `procedure_012 <../procedure_rules.html#procedure-012>`_
|
||||
* `procedure_013 <../procedure_rules.html#procedure-013>`_
|
||||
* `procedure_014 <../procedure_rules.html#procedure-014>`_
|
||||
|
|
@ -173,14 +166,7 @@ Rules Enforcing Structure Rule Group
|
|||
* `signal_007 <../signal_rules.html#signal-007>`_
|
||||
* `signal_015 <../signal_rules.html#signal-015>`_
|
||||
* `signal_017 <../signal_rules.html#signal-017>`_
|
||||
* `signal_018 <../signal_rules.html#signal-018>`_
|
||||
* `signal_403 <../signal_rules.html#signal-403>`_
|
||||
* `source_file_001 <../source_file_rules.html#source-file-001>`_
|
||||
* `subprogram_instantiation_001 <../subprogram_instantiation_rules.html#subprogram-instantiation-001>`_
|
||||
* `subprogram_instantiation_002 <../subprogram_instantiation_rules.html#subprogram-instantiation-002>`_
|
||||
* `subprogram_instantiation_003 <../subprogram_instantiation_rules.html#subprogram-instantiation-003>`_
|
||||
* `subprogram_instantiation_004 <../subprogram_instantiation_rules.html#subprogram-instantiation-004>`_
|
||||
* `subprogram_instantiation_005 <../subprogram_instantiation_rules.html#subprogram-instantiation-005>`_
|
||||
* `subtype_005 <../subtype_rules.html#subtype-005>`_
|
||||
* `subtype_006 <../subtype_rules.html#subtype-006>`_
|
||||
* `type_008 <../type_rules.html#type-008>`_
|
||||
|
|
@ -188,10 +174,7 @@ Rules Enforcing Structure Rule Group
|
|||
* `type_017 <../type_rules.html#type-017>`_
|
||||
* `type_018 <../type_rules.html#type-018>`_
|
||||
* `variable_007 <../variable_rules.html#variable-007>`_
|
||||
* `variable_015 <../variable_rules.html#variable-015>`_
|
||||
* `variable_017 <../variable_rules.html#variable-017>`_
|
||||
* `variable_018 <../variable_rules.html#variable-018>`_
|
||||
* `variable_403 <../variable_rules.html#variable-403>`_
|
||||
* `variable_assignment_006 <../variable_assignment_rules.html#variable-assignment-006>`_
|
||||
* `variable_assignment_007 <../variable_assignment_rules.html#variable-assignment-007>`_
|
||||
* `variable_assignment_008 <../variable_assignment_rules.html#variable-assignment-008>`_
|
||||
|
|
|
|||
|
|
@ -15,7 +15,6 @@ Rules Enforcing Whitespace Rule Group
|
|||
* `architecture_031 <../architecture_rules.html#architecture-031>`_
|
||||
* `architecture_032 <../architecture_rules.html#architecture-032>`_
|
||||
* `architecture_033 <../architecture_rules.html#architecture-033>`_
|
||||
* `array_constraint_100 <../array_constraint_rules.html#array-constraint-100>`_
|
||||
* `assert_100 <../assert_rules.html#assert-100>`_
|
||||
* `assert_101 <../assert_rules.html#assert-101>`_
|
||||
* `assert_102 <../assert_rules.html#assert-102>`_
|
||||
|
|
@ -30,10 +29,6 @@ Rules Enforcing Whitespace Rule Group
|
|||
* `case_004 <../case_rules.html#case-004>`_
|
||||
* `case_005 <../case_rules.html#case-005>`_
|
||||
* `case_006 <../case_rules.html#case-006>`_
|
||||
* `case_generate_alternative_100 <../case_generate_alternative_rules.html#case-generate-alternative-100>`_
|
||||
* `case_generate_alternative_101 <../case_generate_alternative_rules.html#case-generate-alternative-101>`_
|
||||
* `case_generate_statement_100 <../case_generate_statement_rules.html#case-generate-statement-100>`_
|
||||
* `case_generate_statement_101 <../case_generate_statement_rules.html#case-generate-statement-101>`_
|
||||
* `comment_004 <../comment_rules.html#comment-004>`_
|
||||
* `comment_100 <../comment_rules.html#comment-100>`_
|
||||
* `component_002 <../component_rules.html#component-002>`_
|
||||
|
|
@ -55,8 +50,6 @@ Rules Enforcing Whitespace Rule Group
|
|||
* `constant_010 <../constant_rules.html#constant-010>`_
|
||||
* `constant_100 <../constant_rules.html#constant-100>`_
|
||||
* `constant_101 <../constant_rules.html#constant-101>`_
|
||||
* `constrained_array_definition_100 <../constrained_array_definition_rules.html#constrained-array-definition-100>`_
|
||||
* `constrained_array_definition_101 <../constrained_array_definition_rules.html#constrained-array-definition-101>`_
|
||||
* `context_002 <../context_rules.html#context-002>`_
|
||||
* `context_017 <../context_rules.html#context-017>`_
|
||||
* `context_018 <../context_rules.html#context-018>`_
|
||||
|
|
@ -85,12 +78,7 @@ Rules Enforcing Whitespace Rule Group
|
|||
* `external_variable_name_102 <../external_variable_name_rules.html#external-variable-name-102>`_
|
||||
* `external_variable_name_103 <../external_variable_name_rules.html#external-variable-name-103>`_
|
||||
* `external_variable_name_104 <../external_variable_name_rules.html#external-variable-name-104>`_
|
||||
* `file_open_information_100 <../file_open_information_rules.html#file-open-information-100>`_
|
||||
* `file_open_information_101 <../file_open_information_rules.html#file-open-information-101>`_
|
||||
* `file_open_information_102 <../file_open_information_rules.html#file-open-information-102>`_
|
||||
* `file_open_information_103 <../file_open_information_rules.html#file-open-information-103>`_
|
||||
* `file_100 <../file_rules.html#file-100>`_
|
||||
* `file_101 <../file_rules.html#file-101>`_
|
||||
* `function_100 <../function_rules.html#function-100>`_
|
||||
* `function_101 <../function_rules.html#function-101>`_
|
||||
* `generate_002 <../generate_rules.html#generate-002>`_
|
||||
|
|
@ -104,14 +92,10 @@ Rules Enforcing Whitespace Rule Group
|
|||
* `generic_map_006 <../generic_map_rules.html#generic-map-006>`_
|
||||
* `generic_map_007 <../generic_map_rules.html#generic-map-007>`_
|
||||
* `generic_map_100 <../generic_map_rules.html#generic-map-100>`_
|
||||
* `generic_map_101 <../generic_map_rules.html#generic-map-101>`_
|
||||
* `if_003 <../if_rules.html#if-003>`_
|
||||
* `if_004 <../if_rules.html#if-004>`_
|
||||
* `if_005 <../if_rules.html#if-005>`_
|
||||
* `if_015 <../if_rules.html#if-015>`_
|
||||
* `index_constraint_100 <../index_constraint_rules.html#index-constraint-100>`_
|
||||
* `index_subtype_definition_100 <../index_subtype_definition_rules.html#index-subtype-definition-100>`_
|
||||
* `index_subtype_definition_101 <../index_subtype_definition_rules.html#index-subtype-definition-101>`_
|
||||
* `instantiation_002 <../instantiation_rules.html#instantiation-002>`_
|
||||
* `instantiation_003 <../instantiation_rules.html#instantiation-003>`_
|
||||
* `instantiation_032 <../instantiation_rules.html#instantiation-032>`_
|
||||
|
|
@ -128,10 +112,6 @@ Rules Enforcing Whitespace Rule Group
|
|||
* `package_009 <../package_rules.html#package-009>`_
|
||||
* `package_body_100 <../package_body_rules.html#package-body-100>`_
|
||||
* `package_body_101 <../package_body_rules.html#package-body-101>`_
|
||||
* `package_instantiation_100 <../package_instantiation_rules.html#package-instantiation-100>`_
|
||||
* `package_instantiation_101 <../package_instantiation_rules.html#package-instantiation-101>`_
|
||||
* `package_instantiation_102 <../package_instantiation_rules.html#package-instantiation-102>`_
|
||||
* `package_instantiation_103 <../package_instantiation_rules.html#package-instantiation-103>`_
|
||||
* `port_003 <../port_rules.html#port-003>`_
|
||||
* `port_007 <../port_rules.html#port-007>`_
|
||||
* `port_008 <../port_rules.html#port-008>`_
|
||||
|
|
@ -139,10 +119,8 @@ Rules Enforcing Whitespace Rule Group
|
|||
* `port_020 <../port_rules.html#port-020>`_
|
||||
* `port_100 <../port_rules.html#port-100>`_
|
||||
* `port_101 <../port_rules.html#port-101>`_
|
||||
* `port_map_006 <../port_map_rules.html#port-map-006>`_
|
||||
* `port_map_007 <../port_map_rules.html#port-map-007>`_
|
||||
* `port_map_100 <../port_map_rules.html#port-map-100>`_
|
||||
* `port_map_101 <../port_map_rules.html#port-map-101>`_
|
||||
* `procedure_100 <../procedure_rules.html#procedure-100>`_
|
||||
* `procedure_101 <../procedure_rules.html#procedure-101>`_
|
||||
* `procedure_call_100 <../procedure_call_rules.html#procedure-call-100>`_
|
||||
|
|
@ -152,8 +130,6 @@ Rules Enforcing Whitespace Rule Group
|
|||
* `process_014 <../process_rules.html#process-014>`_
|
||||
* `process_024 <../process_rules.html#process-024>`_
|
||||
* `process_025 <../process_rules.html#process-025>`_
|
||||
* `range_constraint_100 <../range_constraint_rules.html#range-constraint-100>`_
|
||||
* `range_constraint_101 <../range_constraint_rules.html#range-constraint-101>`_
|
||||
* `record_type_definition_100 <../record_type_definition_rules.html#record-type-definition-100>`_
|
||||
* `record_type_definition_101 <../record_type_definition_rules.html#record-type-definition-101>`_
|
||||
* `report_statement_100 <../report_statement_rules.html#report-statement-100>`_
|
||||
|
|
@ -173,20 +149,12 @@ Rules Enforcing Whitespace Rule Group
|
|||
* `signal_100 <../signal_rules.html#signal-100>`_
|
||||
* `signal_101 <../signal_rules.html#signal-101>`_
|
||||
* `signal_102 <../signal_rules.html#signal-102>`_
|
||||
* `subprogram_instantiation_100 <../subprogram_instantiation_rules.html#subprogram-instantiation-100>`_
|
||||
* `subprogram_instantiation_101 <../subprogram_instantiation_rules.html#subprogram-instantiation-101>`_
|
||||
* `subprogram_instantiation_102 <../subprogram_instantiation_rules.html#subprogram-instantiation-102>`_
|
||||
* `subprogram_instantiation_103 <../subprogram_instantiation_rules.html#subprogram-instantiation-103>`_
|
||||
* `subprogram_instantiation_104 <../subprogram_instantiation_rules.html#subprogram-instantiation-104>`_
|
||||
* `subtype_100 <../subtype_rules.html#subtype-100>`_
|
||||
* `subtype_101 <../subtype_rules.html#subtype-101>`_
|
||||
* `subtype_102 <../subtype_rules.html#subtype-102>`_
|
||||
* `type_006 <../type_rules.html#type-006>`_
|
||||
* `type_007 <../type_rules.html#type-007>`_
|
||||
* `type_100 <../type_rules.html#type-100>`_
|
||||
* `unbounded_array_definition_100 <../unbounded_array_definition_rules.html#unbounded-array-definition-100>`_
|
||||
* `unbounded_array_definition_101 <../unbounded_array_definition_rules.html#unbounded-array-definition-101>`_
|
||||
* `unbounded_array_definition_102 <../unbounded_array_definition_rules.html#unbounded-array-definition-102>`_
|
||||
* `variable_005 <../variable_rules.html#variable-005>`_
|
||||
* `variable_006 <../variable_rules.html#variable-006>`_
|
||||
* `variable_100 <../variable_rules.html#variable-100>`_
|
||||
|
|
@ -202,10 +170,8 @@ Rules Enforcing Whitespace Rule Group
|
|||
* `whitespace_005 <../whitespace_rules.html#whitespace-005>`_
|
||||
* `whitespace_006 <../whitespace_rules.html#whitespace-006>`_
|
||||
* `whitespace_007 <../whitespace_rules.html#whitespace-007>`_
|
||||
* `whitespace_008 <../whitespace_rules.html#whitespace-008>`_
|
||||
* `whitespace_010 <../whitespace_rules.html#whitespace-010>`_
|
||||
* `whitespace_011 <../whitespace_rules.html#whitespace-011>`_
|
||||
* `whitespace_013 <../whitespace_rules.html#whitespace-013>`_
|
||||
* `whitespace_100 <../whitespace_rules.html#whitespace-100>`_
|
||||
* `whitespace_101 <../whitespace_rules.html#whitespace-101>`_
|
||||
* `whitespace_102 <../whitespace_rules.html#whitespace-102>`_
|
||||
* `whitespace_103 <../whitespace_rules.html#whitespace-103>`_
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ The rules are divided into categories depending on the part of the VHDL code bei
|
|||
aggregate_rules.rst
|
||||
alias_declaration_rules.rst
|
||||
architecture_rules.rst
|
||||
array_constraint_rules.rst
|
||||
assert_rules.rst
|
||||
attribute_rules.rst
|
||||
attribute_declaration_rules.rst
|
||||
|
|
@ -21,18 +20,15 @@ The rules are divided into categories depending on the part of the VHDL code bei
|
|||
case_rules.rst
|
||||
case_generate_alternative_rules.rst
|
||||
case_generate_statement_rules.rst
|
||||
choice_rules.rst
|
||||
comment_rules.rst
|
||||
component_rules.rst
|
||||
concurrent_rules.rst
|
||||
conditional_expressions_rules.rst
|
||||
conditional_waveforms_rules.rst
|
||||
constant_rules.rst
|
||||
constrained_array_definition_rules.rst
|
||||
context_rules.rst
|
||||
context_ref_rules.rst
|
||||
declarative_part_rules.rst
|
||||
delay_mechanism_rules.rst
|
||||
element_association_rules.rst
|
||||
entity_rules.rst
|
||||
entity_specification_rules.rst
|
||||
|
|
@ -42,8 +38,6 @@ The rules are divided into categories depending on the part of the VHDL code bei
|
|||
external_signal_name_rules.rst
|
||||
external_variable_name_rules.rst
|
||||
file_rules.rst
|
||||
file_open_information_rules.rst
|
||||
file_type_definition_rules.rst
|
||||
for_loop_rules.rst
|
||||
for_generate_statement_rules.rst
|
||||
function_rules.rst
|
||||
|
|
@ -53,10 +47,7 @@ The rules are divided into categories depending on the part of the VHDL code bei
|
|||
ieee_rules.rst
|
||||
if_rules.rst
|
||||
if_generate_statement_rules.rst
|
||||
index_constraint_rules.rst
|
||||
index_subtype_definition_rules.rst
|
||||
instantiation_rules.rst
|
||||
interface_incomplete_type_declaration_rules.rst
|
||||
iteration_scheme_rules.rst
|
||||
length_rules.rst
|
||||
library_rules.rst
|
||||
|
|
@ -66,8 +57,6 @@ The rules are divided into categories depending on the part of the VHDL code bei
|
|||
null_statement_rules.rst
|
||||
package_rules.rst
|
||||
package_body_rules.rst
|
||||
package_instantiation_rules.rst
|
||||
parameter_specification_rules.rst
|
||||
port_rules.rst
|
||||
port_map_rules.rst
|
||||
pragma_rules.rst
|
||||
|
|
@ -76,7 +65,6 @@ The rules are divided into categories depending on the part of the VHDL code bei
|
|||
process_rules.rst
|
||||
protected_type_rules.rst
|
||||
protected_type_body_rules.rst
|
||||
range_constraint_rules.rst
|
||||
range_rules.rst
|
||||
record_type_definition_rules.rst
|
||||
report_statement_rules.rst
|
||||
|
|
@ -85,16 +73,11 @@ The rules are divided into categories depending on the part of the VHDL code bei
|
|||
selected_assignment_rules.rst
|
||||
sequential_rules.rst
|
||||
signal_rules.rst
|
||||
shift_operator_rules.rst
|
||||
source_file_rules.rst
|
||||
subprogram_body_rules.rst
|
||||
subprogram_instantiation_rules.rst
|
||||
subprogram_kind_rules.rst
|
||||
subtype_rules.rst
|
||||
type_rules.rst
|
||||
type_mark_rules.rst
|
||||
unfixable_rules.rst
|
||||
unbounded_array_definition_rules.rst
|
||||
use_clause_rules.rst
|
||||
variable_rules.rst
|
||||
variable_assignment_rules.rst
|
||||
|
|
|
|||
|
|
@ -1,25 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Shift Operator Rules
|
||||
--------------------
|
||||
|
||||
shift_operator_500
|
||||
##################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks shift operators have proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
a <= b SLL c;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
a <= b sll c;
|
||||
|
|
@ -178,14 +178,14 @@ Default signal prefix is *s_*.
|
|||
signal_010
|
||||
##########
|
||||
|
||||
The function of this rule has been moved to rule type_mark_500.
|
||||
The function of this rule has been moved to rule ieee_500.
|
||||
|
||||
signal_011
|
||||
##########
|
||||
|
||||
The function of this rule has been superseded by the following rules:
|
||||
|
||||
* type_mark_500
|
||||
* ieee_500
|
||||
* subtype_002
|
||||
* type_014
|
||||
|
||||
|
|
@ -334,31 +334,6 @@ This rule checks the structure of signal constraints.
|
|||
element2(3 downto 0)
|
||||
);
|
||||
|
||||
signal_018
|
||||
##########
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the **:=** is on the same line as the **signal** keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal size : integer
|
||||
:= 1;
|
||||
signal width : integer
|
||||
:= 32;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal size : integer :=
|
||||
1;
|
||||
signal width : integer :=
|
||||
32;
|
||||
|
||||
signal_100
|
||||
##########
|
||||
|
||||
|
|
@ -481,96 +456,6 @@ This rule checks alignment of multiline constraints in signal declarations.
|
|||
element2(3 downto 0)
|
||||
);
|
||||
|
||||
signal_401
|
||||
##########
|
||||
|
||||
|phase_5| |error| |alignment|
|
||||
|
||||
This rule checks the alignment of assignment keywords in signal declarations.
|
||||
|
||||
|configuring_keyword_alignment_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal c_default_values : t_address_en := (
|
||||
c_address_control => false,
|
||||
c_address_data => true,
|
||||
others => false
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal c_default_values : t_address_en := (
|
||||
c_address_control => false,
|
||||
c_address_data => true,
|
||||
others => false
|
||||
);
|
||||
|
||||
signal_402
|
||||
##########
|
||||
|
||||
|phase_5| |error| |alignment|
|
||||
|
||||
This rule checks the alignment of multiline signal initializations that contain arrays.
|
||||
|
||||
|configuring_multiline_indent_rules_link|
|
||||
|
||||
.. NOTE:: The structure of multiline array signal initializations is handled by the rule `signal_403 <signal_rules.html#signal-403>`_.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal rom : romq_type :=
|
||||
(
|
||||
0,
|
||||
65535,
|
||||
32768
|
||||
);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal rom : romq_type :=
|
||||
(
|
||||
0,
|
||||
65535,
|
||||
32768
|
||||
);
|
||||
|
||||
signal_403
|
||||
##########
|
||||
|
||||
|phase_5| |error| |structure|
|
||||
|
||||
This rule checks the structure of multiline signal initializations that contain arrays.
|
||||
|
||||
|configuring_array_multiline_structure_rules_link|
|
||||
|
||||
.. NOTE:: The indenting of multiline array signal initializations is handled by the rule `signal_402 <signal_rules.html#signal-402>`_.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal rom : romq_type := (0, 65535, 32768);
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal rom : romq_type :=
|
||||
(
|
||||
0,
|
||||
65535,
|
||||
32768
|
||||
);
|
||||
|
||||
signal_600
|
||||
##########
|
||||
|
||||
|
|
|
|||
|
|
@ -1,293 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Subprogram Instantiation Rules
|
||||
------------------------------
|
||||
|
||||
subprogram_instantiation_001
|
||||
############################
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the new subprogram identifier is on the same line as the **procedure** keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure
|
||||
my_proc is new my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_instantiation_002
|
||||
############################
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the new subprogram identifier is on the same line as the **function** keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
function
|
||||
my_func is new my_generic_func
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
function my_func is new my_generic_func
|
||||
|
||||
subprogram_instantiation_003
|
||||
############################
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the **is** keyword is on the same line as the new subprogram identifier.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc
|
||||
is new my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_instantiation_004
|
||||
############################
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the **new** keyword is on the same line as the **is** keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is
|
||||
new my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_instantiation_005
|
||||
############################
|
||||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the uninstantiated subprogram name is on the same line as the **new** keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new
|
||||
my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_instantiation_100
|
||||
############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between the **procedure** keyword and the new subprogram identifier.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_instantiation_101
|
||||
############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between the **function** keyword and the new subprogram identifier.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
function my_func is new my_generic_func
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
function my_func is new my_generic_func
|
||||
|
||||
subprogram_instantiation_102
|
||||
############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between the new subprogram identifier and the **is** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_instantiation_103
|
||||
############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between the **is** keyword and the **new** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_instantiation_104
|
||||
############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space between **new** keyword and the uninstantiated subprogram name.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_instantiation_500
|
||||
############################
|
||||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks the instantiated package name has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure MY_PROC is new my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_instantiation_501
|
||||
############################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **is** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc IS new my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_instantiation_502
|
||||
############################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **new** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is NEW my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_instantiation_503
|
||||
############################
|
||||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks the uninstantiated subprogram name has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new MY_GENERIC_PROC
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
|
@ -1,54 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Subprogram Kind Rules
|
||||
---------------------
|
||||
|
||||
subprogram_kind_500
|
||||
###################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks that the **procedure** keyword in subprogram kinds has the proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end PROCEDURE parity;
|
||||
|
||||
PROCEDURE my_proc is new my_generic_proc
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end procedure parity;
|
||||
|
||||
procedure my_proc is new my_generic_proc
|
||||
|
||||
subprogram_kind_501
|
||||
###################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks that the **function** keyword in subprogram kinds has the proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end FUNCTION parity;
|
||||
|
||||
FUNCTION my_func is new my_generic_func
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
end function parity;
|
||||
|
||||
function my_func is new my_generic_func
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Type Mark Rules
|
||||
---------------
|
||||
|
||||
type_mark_500
|
||||
#############
|
||||
|
||||
|phase_6| |error| |case| |case_name|
|
||||
|
||||
This rule checks that the type marks without declarations in the current file have proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal my_sig : MY_TYPE_MARK;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
signal my_sig : my_type_mark;
|
||||
|
|
@ -388,7 +388,7 @@ type_017
|
|||
|
||||
|phase_1| |error| |structure|
|
||||
|
||||
This rule checks the identifier is on the same line as the **type** keyword.
|
||||
This rule checks the identifier is on the same line as the type keyword.
|
||||
|
||||
**Violation**
|
||||
|
||||
|
|
|
|||
|
|
@ -1,111 +0,0 @@
|
|||
.. include:: includes.rst
|
||||
|
||||
Unbounded Array Definition Rules
|
||||
--------------------------------
|
||||
|
||||
unbounded_array_definition_100
|
||||
##############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for whitespace after the **array** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array_unconstrained is array (natural range <>) of unsigned;
|
||||
type t_u_array_unconstrained is array (natural range <>) of unsigned;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array_unconstrained is array(natural range <>) of unsigned;
|
||||
type t_u_array_unconstrained is array(natural range <>) of unsigned;
|
||||
|
||||
unbounded_array_definition_101
|
||||
##############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space before the **of** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array_unconstrained is array(natural range <>) of unsigned;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array_unconstrained is array(natural range <>) of unsigned;
|
||||
|
||||
unbounded_array_definition_102
|
||||
##############################
|
||||
|
||||
|phase_2| |error| |whitespace|
|
||||
|
||||
This rule checks for a single space after the **of** keyword.
|
||||
|
||||
|configuring_whitespace_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array_unconstrained is array(natural range <>) of unsigned;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array_unconstrained is array(natural range <>) of unsigned;
|
||||
|
||||
unbounded_array_definition_500
|
||||
##############################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **array** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array_unconstrained is ARRAY(natural range <>) of unsigned;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array_unconstrained is array(natural range <>) of unsigned;
|
||||
|
||||
unbounded_array_definition_501
|
||||
##############################
|
||||
|
||||
|phase_6| |error| |case| |case_keyword|
|
||||
|
||||
This rule checks the **of** keyword has proper case.
|
||||
|
||||
|configuring_uppercase_and_lowercase_rules_link|
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array_unconstrained is array(natural range <>) OF unsigned;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
type t_u_array_unconstrained is array(natural range <>) of unsigned;
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue