[HELP]: Block comment warnings because wrong configuration ?

[wimille]

As i start to use the VSG tools, i've got many questions to adapt the configuration to my cases.
I've got the following :

-----------------------------------------------------------------------------------------------------------------------
-- ENTITY
-----------------------------------------------------------------------------------------------------------------------
entity FILTRE_LIN_NBITS is
    generic (
        G_COUNTER_SIZE  : positive := 4;
        G_COUNTER_THRES : std_logic_vector( G_COUNTER_SIZE - 1 downto 0 ) := ( others => '0' );

With my current config i've got warning on the 2 lines '----'. I've try the configuration given in the documentation, but i've still got error.

What do i miss ?

Thanks for help

[JHertz5]

Hi @wimille

I can try to help but I need more information. Please provide the following:

• A testable piece of code - the snippet that you've provided is not parseable because it cuts off the second half of the entity declaration.
• The content of the warnings that you're receiving - I currently don't even know which rules are failing for you.
• A configuration that reproduces your warnings (this can be skipped if the default config reproduces your warnings.

Thanks!

[wimille]

Hi,

Sorry, you're wright my explanation is not clear without context or example.

HDL code which match the rule "violations" (renamed in txt for github):
filtre_lin_1bit_test.txt

My configuration file , i've disabled all rules expect comment_blocks;
vsg_test.yaml

The output i've got:

Hope this will help you

[JHertz5]

Hi @wimille

Thanks, that makes it much easier. I'm able to reproduce your issue. It seems that the block comment rules with your config expect a line length of 60 for some reason. I haven't dug into why.

I think the default settings of the rules should suit your purposes. Could you try updating your config to use the following snippet (i.e. don't set anything for those rules other than to enable them)?

    # block_comment_001: This rule checks the block comment header is correct.
    block_comment_001:
        disable: false

    # block_comment_002: This rule checks the comment_left attribute exists for all comments.
    block_comment_002:
        disable: false

    # block_comment_003: This rule checks the block comment footer is correct.
    block_comment_003:
        disable: false

On my end, this gives the following with your test file and an updated version of your config:

$ vsg -f test.vhd -c test.yml 
================================================================================
File:  test.vhd
================================================================================
Phase 7 of 7... Reporting
Total Rules Checked: 3
Total Violations:    0
  Error   :     0
  Warning :     0

You mentioned that you're using the configuration from the documentation? If so, perhaps the documentation is incorrect and needs to be updated.

BTW, if you do want to configure it explicitly with these settings, these are what the defaults are

  block_comment_001:
    allow_indenting: true
    disable: false
    header_left:
    header_left_repeat: '-'
    header_string:
    header_right_repeat:
    max_header_column: 120
  block_comment_002:
    allow_indenting: true
    disable: false
    comment_left:
  block_comment_003:
    allow_indenting: true
    disable: false
    footer_left:
    footer_left_repeat: '-'
    footer_string:
    footer_right_repeat:
    max_footer_column: 120

[wimille]

Thank you for your answer.
As you said, i remove all options and just enable the block comment rules. It works.

I've also made test with the configuration you gave, it also works.

However, i've made a comparison with my initial configuration, and i found that i have error if i write <header_string: ''> instead of <header_string: >.

Moreover, for my initial configuration i used the first example given in the documentation:
[https://vhdl-style-guide.readthedocs.io/en/latest/configuring_block_comments.html#configuring-block-comments]

Because for it match with what i want.

Last point, i'm still confusing, is it the right place to ask for help ?

[JHertz5]

Hi @wimille

As you said, i remove all options and just enable the block comment rules. It works.
I've also made test with the configuration you gave, it also works.

Excellent! I'm glad that it's working for you now.

However, i've made a comparison with my initial configuration, and i found that i have error if i write <header_string: ''> instead of <header_string: >.

I think I can reproduce this error, although you haven't given any details, so it's difficult to say. Is this what you're seeing?

$ ./bin/vsg -f test.vhd -c test.yml 
multiprocessing.pool.RemoteTraceback: 
"""
Traceback (most recent call last):
  File "/usr/lib/python3.10/multiprocessing/pool.py", line 125, in worker
    result = (True, func(*args, **kwds))
  File "/home/jhertzog/code/vhdl-style-guide-fork/bin/../vsg/apply_rules.py", line 126, in apply_rules
    oRules.check_rules(
  File "/home/jhertzog/code/vhdl-style-guide-fork/bin/../vsg/rule_list.py", line 229, in check_rules
    oRule.analyze(self.oVhdlFile)
  File "/home/jhertzog/code/vhdl-style-guide-fork/bin/../vsg/rule.py", line 148, in analyze
    self._analyze(lToi)
  File "/home/jhertzog/code/vhdl-style-guide-fork/bin/../vsg/block_rule.py", line 37, in _analyze
    self.analyze_comments(oToi)
  File "/home/jhertzog/code/vhdl-style-guide-fork/bin/../vsg/rules/block_comment/rule_003.py", line 53, in analyze_comments
    analyze_footer(self, oToken, iLine, oToi)
  File "/home/jhertzog/code/vhdl-style-guide-fork/bin/../vsg/rules/block_comment/rule_003.py", line 63, in analyze_footer
    sFooter = self.build_footer(oToken)
  File "/home/jhertzog/code/vhdl-style-guide-fork/bin/../vsg/block_rule.py", line 73, in build_footer
    sFooter += self.footer_right_repeat * (self.max_footer_column - len(sFooter))
TypeError: unsupported operand type(s) for *: 'NoneType' and 'int'
"""

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/jhertzog/code/vhdl-style-guide-fork/./bin/vsg", line 16, in <module>
    main()
  File "/home/jhertzog/code/vhdl-style-guide-fork/bin/../vsg/__main__.py", line 154, in main
    for tResult in pool.imap(f, enumerate(commandLineArguments.filename)):
  File "/usr/lib/python3.10/multiprocessing/pool.py", line 873, in next
    raise value
TypeError: unsupported operand type(s) for *: 'NoneType' and 'int'

I haven't had a chance to investigate fully yet, but I'll take a look when I get a chance.

Moreover, for my initial configuration i used the first example given in the documentation:
[https://vhdl-style-guide.readthedocs.io/en/latest/configuring_block_comments.html#configuring-block-comments]
Because for it match with what i want.

Yep, it looks like there is an error in the documentation. I'll put together a fix for it soon.

Last point, i'm still confusing, is it the right place to ask for help ?

Yes, it's absolutely fine to ask for help in this format!

I'm in a busy period at work and I'm away from my computer for the next few days, so I can't make any promises on when I'll do this work, but I'll keep you updated when it happens.

[JHertz5]

@wimille I've updated the documentation as mentioned previously (sorry for the delay). When you have a chance and confirm that you're happy with the change and, if all of your questions have been answered, we can close this issue.