[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

[Git][lintian/lintian][master] Adjust documentation to the modern pattern for naming checks.



Title: GitLab

Felix Lechner pushed to branch master at lintian / lintian

Commits:

1 changed file:

Changes:

  • doc/lintian.rst
    ... ... @@ -826,17 +826,11 @@ Existing checks can be shadowed by placing a check with the same name in
    826 826
     a directory appearing earlier in the list. This also holds for the
    
    827 827
     checks provided by Lintian itself.
    
    828 828
     
    
    829
    -Checks in Lintian consist of a description file (.desc) and a Perl
    
    830
    -module implementing the actual check (.pm). The names of these checks
    
    831
    -must consist entirely of the lower case characters ([a-z]), digits
    
    832
    -([0-9]), underscore (_), dash (-), period (.) and forward slashes (/).
    
    829
    +Checks in Lintian consist of a Perl module implementing the actual check
    
    830
    +(.pm). The files names of such checks are expected to be in CamelCase. For
    
    831
    +the check name used on the command line, case transitions are replaced with
    
    832
    +hyphens. Perl's two colons (::) are replaced with a slash.
    
    833 833
     
    
    834
    -The check name must be a valid Perl unique module name after the
    
    835
    -following transformations. All periods and dashes are replaced with
    
    836
    -underscores. All forward slashes are replaced with two colons (::).
    
    837
    -
    
    838
    -Check names without a forward slash (e.g. "fields") and names starting
    
    839
    -with either "lintian/" or "coll/" are reserved for the Lintian core.
    
    840 834
     Vendors are recommended to use their vendor name before the first slash
    
    841 835
     (e.g. "ubuntu/fields").
    
    842 836
     
    


  • Reply to: