[GSoC][Patch] Add more builtin patterns for userdiff: Add builtin patterns for Verilog

li li· Mar 13, 2025, 14:23 UTC · lore

Add Verilog built-in to userdiff.c. I read the code and checked the previous mailing list. I found that if I want git to recognize Verilog syntax, I need to add Verilog regular expressions to the userdiff_driver array of userdiff.c and modify the .gitattributes file. Yes, I did it. The next step is to write test cases and submit patches. I am not sure if this is in line with the development process specifications. Maybe I should make some adjustments. If so, please let me know.

Show changes to 2 files +8 −0

.gitattributes, userdiff.c

diff --git a/.gitattributes b/.gitattributes
index 43fa883a84..8aac8574f1 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -6,6 +6,7 @@
 *.pm text eol=lf diff=perl
 *.py text eol=lf diff=python
 *.bat text eol=crlf
+*.v text eof=lf diff=verilog
 CODE_OF_CONDUCT.md -whitespace
 /Documentation/**/*.adoc text eol=lf
 /command-list.txt text eol=lf
diff --git a/userdiff.c b/userdiff.c
index 340c4eb4f7..9f7e4c427d 100644
--- a/userdiff.c
+++ b/userdiff.c
@@ -336,6 +336,13 @@ PATTERNS("scheme",
         "|([^][)(}{[ \t])+"),
 PATTERNS("tex", "^(\\\\((sub)*section|chapter|part)\\*{0,1}\\{.*)$",
         "\\\\[a-zA-Z@]+|\\\\.|([a-zA-Z0-9]|[^\x01-\x7f])+"),
+PATTERNS("verilog",
+             "^[ \t]*((module|task|function)[ \t].*)$",
+             /* -- */
+             "[a-zA-Z_][a-zA-Z0-9_]*"  
+             "|[0-9]+'[bdh][0-9a-fA-F_]+"  
+             "|<=|>=|==|!=|\\|\\||&&|<<|>>"
+    ),
 { .name = "default", .binary = -1 },
 };
 #undef PATTERNS

Patrick Steinhardt· Mar 24, 2025, 13:17 UTC · re: li li · lore

Re: [GSoC][Patch] Add more builtin patterns for userdiff: Add builtin patterns for Verilog

Hi Li,

On Thu, Mar 13, 2025 at 02:23:05PM +0000, li li wrote:

> Add Verilog built-in to userdiff.c. I read the code and checked the previous mailing list. I found that if I want git to recognize Verilog syntax, I need to add Verilog regular expressions to the userdiff_driver array of userdiff.c and modify the .gitattributes file.
> Yes, I did it.
> The next step is to write test cases and submit patches.
> I am not sure if this is in line with the development process specifications. Maybe I should make some adjustments. If so, please let me know.

I would recommend to read up on how to submit patches in "Documentation/SubmittingPatches". There's also "Documentation/MyFirstContribution.adoc" to give more background on how things work in our community.

Show 9 quoted lines

> diff --git a/.gitattributes b/.gitattributes
> index 43fa883a84..8aac8574f1 100644
> --- a/.gitattributes
> +++ b/.gitattributes
> @@ -6,6 +6,7 @@
>  *.pm text eol=lf diff=perl
>  *.py text eol=lf diff=python
>  *.bat text eol=crlf
> +*.v text eof=lf diff=verilog

The gitattributes file is specific to files stored in this particular project, and we don't have any Verilog files in our tree. So this change should be dropped.

Show 21 quoted lines

>  CODE_OF_CONDUCT.md -whitespace
>  /Documentation/**/*.adoc text eol=lf
>  /command-list.txt text eol=lf
> diff --git a/userdiff.c b/userdiff.c
> index 340c4eb4f7..9f7e4c427d 100644
> --- a/userdiff.c
> +++ b/userdiff.c
> @@ -336,6 +336,13 @@ PATTERNS("scheme",
>          "|([^][)(}{[ \t])+"),
>  PATTERNS("tex", "^(\\\\((sub)*section|chapter|part)\\*{0,1}\\{.*)$",
>          "\\\\[a-zA-Z@]+|\\\\.|([a-zA-Z0-9]|[^\x01-\x7f])+"),
> +PATTERNS("verilog",
> +             "^[ \t]*((module|task|function)[ \t].*)$",
> +             /* -- */
> +             "[a-zA-Z_][a-zA-Z0-9_]*"  
> +             "|[0-9]+'[bdh][0-9a-fA-F_]+"  
> +             "|<=|>=|==|!=|\\|\\||&&|<<|>>"
> +    ),
>  { .name = "default", .binary = -1 },
>  };
>  #undef PATTERNS

I cannot say much about this hunk as I've never written or even read any Verilog :)

Patrick

[1]: https://gitgitgadget.github.io/

patchAdd more builtin patterns for userdiff: Add builtin patterns for Verilog