jeremiah-c-leary / vhdl-style-guide

Style guide enforcement for VHDL
GNU General Public License v3.0
192 stars 40 forks source link

Case rules for directions in formal parameter declarations for functions and procedures #1252

Closed JHertz5 closed 1 month ago

JHertz5 commented 1 month ago

Is your feature request related to a problem? Please describe. At the moment, there are no rules to enforce the case of direction keywords (in, out, inout) in formal parameter declarations in functions and procedures.

Describe the solution you'd like I would like a rule to enforce the case of these keywords, e.g. turning

architecture rtl of test is

  procedure my_proc (
    PARAM1 : IN integer;
    PARAM2 : OUT integer
  ) is
  begin

  end procedure my_proc;

  function my_func (
    PARAM1 : IN integer;
    PARAM2 : OUT integer
  ) return integer is
  begin

  end function my_func;

begin

end architecture rtl;

to

architecture rtl of test is

  procedure my_proc (
    PARAM1 : in integer;
    PARAM2 : out integer
  ) is
  begin

  end procedure my_proc;

  function my_func (
    PARAM1 : in integer;
    PARAM2 : out integer
  ) return integer is
  begin

  end function my_func;

begin

end architecture rtl;
JHertz5 commented 1 month ago

I'm planning to raise a PR to address this.

JHertz5 commented 1 month ago

Use port_019 as an example.

JHertz5 commented 1 month ago

PR #1260 raised.

jeremiah-c-leary commented 1 month ago

Evening @JHertz5 ,

Another perfect PR.

It never ceases to amaze me how much there is format.

I will get this merged to master.

Thanks again,

--Jeremy

JHertz5 commented 1 month ago

Thanks very much! Yes, it's quite incredible haha