library_rules.rst

Library Rules

library_001

|phase_4| |error| |indent|

This rule checks the indent of the library keyword. Indenting helps in comprehending the code.

Violation

library ieee;
   library fifo_dsn;

Fix

library ieee;
library fifo_dsn;

library_002

|phase_2| |error| |whitespace|

This rule checks for excessive spaces after the library keyword.

|configuring_whitespace_rules_link|

Violation

library    ieee;

Fix

library ieee;

library_003

|phase_3| |error| |blank_line|

This rule checks for blank lines or comments above the library keyword.

|configuring_previous_line_rules_link|

There is an additional allow_library_clause option which can be set. Refer to section :ref:`reporting-single-rule-configuration` for details on finding configuration options for individual rules.

allow_library_clause

When set to True, it allows consecutive library clauses.

Violation

library ieee;
  use ieee.std_logic_1164.all;
library top_dsn;
library fifo_dsn;

Fix

library ieee;
  use ieee.std_logic_1164.all;

library top_dsn;
library fifo_dsn;

library_004

|phase_6| |error| |case| |case_keyword|

This rule checks the library keyword has proper case.

|configuring_uppercase_and_lowercase_rules_link|

Violation

Library ieee;

LIBRARY fifo_dsn;

Fix

library ieee;

library fifo_dsn;

library_005

|phase_6| |error| |case| |case_keyword|

This rule checks the use keyword has proper case.

|configuring_uppercase_and_lowercase_rules_link|

Violation

library ieee;
  USE ieee.std_logic_1164.all;
  Use ieee.std_logic_unsigned.all;

Fix

library ieee;
  use ieee.std_logic_1164.all;
  use ieee.std_logic_unsigned.all;

library_006

|phase_2| |error| |whitespace|

This rule checks for excessive spaces after the use keyword.

|configuring_whitespace_rules_link|

Violation

library ieee;
  use    ieee.std_logic_1164.all;
  use   ieee.std_logic_unsigned.all;

Fix

library ieee;
  use ieee.std_logic_1164.all;
  use ieee.std_logic_unsigned.all;

library_007

|phase_3| |error| |blank_line|

This rule checks for blank lines or comments above the use declaration.

|configuring_previous_line_rules_link|

The default style is no_blank_line.

Violation

library ieee;

  use ieee.std_logic_1164.all;

  use ieee.std_logic_unsigned.all;

Fix

library ieee;
  use ieee.std_logic_1164.all;
  use ieee.std_logic_unsigned.all;

library_008

|phase_4| |error| |indent|

This rule checks the indent of the use keyword.

Violation

library ieee;
use ieee.std_logic_1164.all;
     use ieee.std_logic_unsigned.all;

Fix

library ieee;
  use ieee.std_logic_1164.all;
  use ieee.std_logic_unsigned.all;

library_009

|phase_4| |error| |alignment|

This rule checks alignment of comments above library use statements.

Violation

library ieee;
-- Use standard logic library
  use ieee.std_logic_1164.all;

Fix

library ieee;
  -- Use standard logic library
  use ieee.std_logic_1164.all;

library_010

|phase_1| |error| |structure|

This rule checks the library keyword is on its own line.

Violation

context c1 is library ieee; use ieee.std_logic_1164.all; end context c1;

Fix

context c1 is
  library ieee; use ieee.std_logic_1164.all; end context c1;

library_011

|phase_1| |error| |structure|

This rule checks the use keyword is on its own line.

Violation

context c1 is library ieee; use ieee.std_logic_1164.all; end context c1;

Fix

context c1 is library ieee;
    use ieee.std_logic_1164.all; end context c1;

library_500

|phase_6| |error| |case| |case_name|

This rule checks the logical_name in a library_clause has proper case.

|configuring_uppercase_and_lowercase_rules_link|

Violation

library IEEE;

library FIFO_dsn;

Fix

library ieee;

library fifo_dsn;

library_600

This rule has been moved to library_500.