Commit Graph

218 Commits

Author SHA1 Message Date
Jeremiah Leary edf8abe371
Adding images to show now to run VSG from Notepad++ 2019-10-13 20:59:52 -04:00
Jeremiah C Leary 23bc434ff6 Updates for issue #257:
Process labels not on the same line as the process must be moved to the same line as the process keyword.

  1)  Updated documentation
  2)  Added tests
  3)  Added rule process_032
2019-10-13 11:16:29 -05:00
Jeremiah C Leary 112bb79cd6 Updates for issue #256:
Added rule whitespace_013 to enforce a space around logic operators.

  1)  Added documentation
  2)  Added tests
  3)  Added rule whitespace_013
2019-10-13 07:22:01 -05:00
Jeremiah C Leary 0b4c10ee5c Updates for issue #265:
Adding rule architecture_025 to enforce naming of architectures.

  1)  Added tests
  2)  Added documentation
  3)  Added rule architecture_025
2019-10-12 21:04:43 -05:00
Jeremiah C Leary a0ccff78ab Adding documentation on how to change the default value for lowercase and uppercase rules. 2019-10-12 09:24:25 -05:00
Jeremiah Leary db5023db51
Merge pull request #264 from m-kru/master
Update docs.
2019-10-12 09:34:44 -04:00
Michał Kruszewski fbd038c681 Update docs. 2019-10-12 10:09:50 +02:00
Jeremiah C Leary 1031fac933 Fixing rendering issue for JSON in Note for instantiation rules documentation. 2019-10-11 15:32:03 -05:00
Jeremiah C Leary 1acc2a9623 Updates for issue #260:
Adding information on how to run tests to the contributing section of the documentation.
2019-10-11 15:30:07 -05:00
Michał Kruszewski 2b9c9a7f8d Add rule for checking if generic name starts with G_. 2019-09-24 21:05:28 +02:00
Jeremiah C Leary 2eb03b720a Updates for issue #248:
Added rule after_003 to detect and remove after assignments in a reset portion of a clock process:

  1)  Added documentation
  2)  Added rule after_003
  3)  Added tests
2019-09-08 07:01:39 -05:00
Jeremiah C Leary b49228af3f Updating usage for version argument. 2019-07-03 21:00:43 -05:00
Jeremiah C Leary d9d1940cda Updates for issue #195
Added rule to align after keyword in clock processes.

  1)  Added documentation
  2)  Added rule after_002
  3)  Added tests
2019-06-28 19:31:10 -05:00
Jeremiah C Leary 952e4771b9 Update for issue #196:
Added fix logic for rule after_001.
  1)  Added configurable attributes magnitude and units
  2)  Updated documentation
  3)  Updated tests
  4)  Updated clock process classification to detect clock processes without resets
2019-06-28 18:43:40 -05:00
Jeremiah C Leary e6ff07855c Updates for issue #196
Adding test for after statement in clock process:

  1)  Enhanced testing
  2)  Added after_001 rule
  3)  Updated documentation
  4)  Fixed bug in detecting the end of a sequential statement
  5)  Updated classification logic
2019-06-28 15:12:44 -05:00
Jeremiah C Leary 68c6a3860c Updates for issue #245
Fixed conflict between comment_007 and comment_008.

  1)  Renumbered comment_007 to comment_010.  This ensures it is ran after comment_008.
  2)  Updated documentation
  3)  Updated tests
2019-06-28 10:38:23 -05:00
Jeremiah C Leary 9dfa8c81cc Fixing indent on NOTE. 2019-06-28 10:36:38 -05:00
Jeremiah C Leary 3623151b5b Updates for issue #246
1) Added version argument to display version.
2) Refactored version information to reside in a single file.
   a)  setup.py references this file
   b)  conf.py references this file
   c)  version argument references this file
2019-06-28 07:48:37 -05:00
Jeremiah C Leary 5c2df4e44b Preparing for release 0.38. 2019-06-09 21:11:38 -05:00
Jeremiah C Leary 8c8d89b3e6 Updates for issue #231:
Added more documentation on how to write a rule.
Added comments to methods of rule class.
2019-06-09 15:29:18 -05:00
Jeremiah C Leary 1794194dff Adding instructions on how to align constant, signal, type, subtype, and file declarations. 2019-06-09 15:28:20 -05:00
Jeremiah C Leary 5f24ef6f9b Updates for issue #241:
The spacing after "signal", "constant", "file", "type", and "subtype" keywords is configurable.

  1)  Added tests
  2)  Refactored code to allow for configurable spacing
  3)  Added subtype_003 rule
  4)  Updated documentation
2019-06-09 11:48:07 -05:00
Jeremiah C Leary a7d0aa556d Updates for issue #237
Added rule constant_014 to handle multiline non array constants:

  1)  Added documentation
  2)  Fixed rule constant_012 so it does not fire on non array constants
  3)  Added rule constant_014
  4)  Added tests
  5)  Added classification of array constants
2019-06-08 11:22:31 -05:00
Jeremiah C Leary 7c68c55ca5 Updates for issue #236:
Updated assert_001 to indent everything after the assert statement.

  1)  Updated documentation
  2)  Updated tests
  3)  Updated assert_001 rule
2019-06-07 22:32:08 -05:00
Jeremiah C Leary 46d57be6db Updates for issue #239:
Clarified constant_010 to state a single space before the :=.

  1)  Updated documentation
  2)  Updated tests to cover more than one space before the :=
  3)  Updated solution for constant_010
2019-06-07 22:16:21 -05:00
Jeremiah C Leary 50f90c2f03 Updates for issue #240:
Updated instantiation_004 rule to allow for comments on the line above an instantiation.

  1)  Updated documentation
  2)  Updated tests
  3)  Updated rule
2019-06-07 21:54:12 -05:00
Jeremiah C Leary 4590726788 Updates for issue #233
Added rules for comments above elsif and else keywords:

  1)  Added documentation
  2)  Added tests
  3)  Added comment_008 and comment_009 rules
2019-06-07 21:40:59 -05:00
Jeremiah C Leary fcb59f21d4 Updates for issue #238:
Added generic_019 to check for blank lines above the );.

  1)  Added documentation
  2)  Added tests
  3)  Refactored generic tests to use setUp method
  4)  Implemented rule
2019-06-06 20:08:04 -05:00
Jeremiah C Leary e6240f87d0 Updates for issue #238:
Added rule to check for blank lines before the ); for port maps.

  1)  Added documentation
  2)  Added tests
  3)  Refactored port tests and added a setUp proc
  4)  Added rule
2019-06-06 18:44:49 -05:00
Jeremiah C Leary 7274b684d2 Preparing for release 0.37. 2019-04-29 20:38:10 -05:00
Jeremiah C Leary ddf19ddfd0 Updating documentation. 2019-04-11 08:10:37 -05:00
Jeremiah C Leary b69d90e5ad Preparing for release 0.36 2019-04-09 19:42:37 -05:00
Jeremiah C Leary 81ce015d1c Updates for issue #227
Adding three rules:  for_loop_003, for_loop_004, and for_loop_005.

  1)  Added documentation for new rules
  2)  Added tests for new rules
  3)  Refactored tests for rules 001 and 002
  4)  Added rules 003, 004, and 005
2019-04-09 19:36:50 -05:00
Jeremiah C Leary 51a4aac729 Updates for issue #227
Adding check for loop label.
2019-04-09 18:58:02 -05:00
Jeremiah C Leary bdcb448bfa Updates for issue #225
Minor updates to documentation.
2019-04-02 21:35:40 -05:00
Jeremiah C Leary 63787d4c78 Updates for issue #225
Added rules to handle the component keyword in component instantiations:

  1)  Enforce component keyword to lowercase
      a)  Added documentation
      b)  Added test
      c)  Added rule instantiation_031
      d)  This rule is disabled by default
  2)  Enforce a single space after the component keyword
      a)  Added documentation
      b)  Added test
      c)  Added rule instantiation_032
      d)  This rule is disabled by default
  3)  Remove component keyword
      a)  Added documentation
      b)  Added test
      c)  Added rule instantiation_033
2019-04-02 21:26:13 -05:00
Jeremiah C Leary d2a226b855 Preparing for release 0.35 2019-03-31 10:07:03 -05:00
Jeremiah C Leary aae2fc9a4e Updates for issue #224
Adding case consistency checks for variable names:

  1)  Added documentation
  2)  Added tests
  3)  Added rule variable_011
2019-03-31 09:54:08 -05:00
Jeremiah C Leary 080be8ae3c Updates for issue #224
Adding case consistency checks for procedure names:

  1)  Added documentation
  2)  Added tests
  3)  Added rule procedure_007
2019-03-31 09:28:16 -05:00
Jeremiah C Leary f2da8b4fe0 Updates for issue #224
Adding consistency case checks for function names.

  1)  Added documentation
  2)  Added tests
  3)  Added rule function_010
2019-03-31 09:10:41 -05:00
Jeremiah C Leary 8e54137964 Updates for issue #224
Adding consistent case checks for subtypes:

  1)  Added documentation
      a)  Updated subtype_001 documentation
      b)  Added subtype_002 documentation
  2)  Added tests
  3)  Added rule subtype_002
2019-03-31 08:50:40 -05:00
Jeremiah C Leary f9c6a495b5 Updates for issue #224
Adding case consistency checks for type definitions:

  1)  Added documentation
  2)  Added tests
  3)  Added rule type_014
2019-03-31 08:22:28 -05:00
Jeremiah C Leary ac04afe067 Updates for issue #224
Adding case consistency checks for constants.

  1)  Added documentation
  2)  Added tests
  3)  Added rule constant_013
2019-03-31 07:38:35 -05:00
Jeremiah C Leary 0c87b5bb70 Updates for issue #224
Switched general_001 to signal_014:

  1)  Removed rule general_001
      a)  Removed documentation
      b)  Removed tests
      c)  Removed rule
  2)  Added signal_014 to validate signal names are consistently cased
      a)  Added documentation
      b)  Added tests
      c)  Added rule signal_014
      d)  Added extract_signal_names procedure in utils.py
2019-03-30 20:11:13 -05:00
Jeremiah C Leary c754653534 Updates for issue #224
Added documentation for new general_001 rule to check capitalization.
Fixed renaming of extract_keywords to extract_non_keywords.
2019-03-27 21:40:49 -05:00
Jeremiah C Leary 402ca5f55f Renaming example formatting to gallery. 2019-03-27 21:27:40 -05:00
Jeremiah C Leary b287d7cd92 Fixing code example widths.
Minor grammar updates.
2019-03-24 22:07:50 -05:00
Jeremiah C Leary a91f5bb743 Updates for issue #223
Adding documentation for new --output_configuration command line argument
2019-03-24 21:56:48 -05:00
Jeremiah C Leary a1904b6f65 Updates for issue #222
Added code examples to documentation.
2019-03-24 09:49:59 -05:00
Jeremiah C Leary 0a4946ae06 Preparing for release 0.34 2019-03-23 08:55:47 -05:00