Add "use-patchdiff" option
cover Add "use-patchdiff" option
This patchset adds a feature to enable Coccinelle to only check all those files in a directory which were modified. It parses all the files obtained from the output of "git diff" and checks them against the specified cocci script.
An example for passing the "use-patchdiff" option is:
spatch -D report --sp-file for_each_child.cocci --use-patchdiff drivers/gpu
One thing to note while using the command is that while it can be invoked outside the target project directory, an absolute path to the target folder should be specified in such cases as.
Sumera Priyadarsini (2):
parsing_cocci: Add feature to check only modified files
docs: manual: Add option description in spatch_options
Makefile | 2 +- docs/manual/spatch_options.tex | 5 ++ enter.ml | 17 +++-- globals/flag.ml | 2 +- globals/flag.mli | 2 +- ocaml/coccilib.mli | 1 + parsing_cocci/get_constants2.ml | 1 + parsing_cocci/patch_diff.ml | 118 ++++++++++++++++++++++++++++++++ parsing_cocci/patch_diff.mli | 9 +++ 9 files changed, 148 insertions(+), 9 deletions(-) create mode 100755 parsing_cocci/patch_diff.ml create mode 100644 parsing_cocci/patch_diff.mli
Signature · 6 lines
2.31.1 _______________________________________________ Cocci mailing list [email protected] https://systeme.lip6.fr/mailman/listinfo/cocci
PATCH 1/2 parsing_cocci: Add feature to check only modified files
This patch adds an option "use-patchdiff" to allow for applying a semantic patch to only those files in a directory where code additions have been made.
Usage: spatch -D <mode> --sp-file <cocci script> --use-patchdiff <target directory>
Example: spatch -D report --sp-file for_each_child.cocci --use-patchdiff drivers/gpu
--- Makefile | 2 +- enter.ml | 17 +++-- globals/flag.ml | 2 +- globals/flag.mli | 2 +- ocaml/coccilib.mli | 1 + parsing_cocci/get_constants2.ml | 1 + parsing_cocci/patch_diff.ml | 118 ++++++++++++++++++++++++++++++++ parsing_cocci/patch_diff.mli | 9 +++ 8 files changed, 143 insertions(+), 9 deletions(-) create mode 100755 parsing_cocci/patch_diff.ml create mode 100644 parsing_cocci/patch_diff.mli
Makefile +1 -1
@@ -44,7 +44,7 @@ SOURCES_parsing_cocci := \ parse_printf.ml parse_aux.ml cleanup_rules.ml disjdistr.ml \ parser_cocci_menhir.mly lexer_cocci.mll \ lexer_cli.mll lexer_script.mll \ - cocci_grep.ml dpll.ml get_constants2.ml id_utils.ml git_grep.ml \ + cocci_grep.ml dpll.ml get_constants2.ml id_utils.ml git_grep.ml patch_diff.ml \ adjacency.ml commas_on_lists.ml re_constraints.ml parse_cocci.ml \ command_line.ml cocci_args.ml SOURCES_parsing_c := \
enter.ml +11 -6
@@ -18,9 +18,7 @@ module Inc = Includes * globals/config.ml, mainly a standard.h and standard.iso file *) let cocci_file = ref "" - let opt_c_files = ref [] - let output_file = ref "" (* resulting code *) let tmp_dir = ref "" (* temporary files for parallelism *) let aux_file_suffix =
@@ -283,7 +281,6 @@ let print_version () = let short_options = [ "--sp-file", Arg.Set_string cocci_file, " <file> the semantic patch file"; - "--opt-c", Arg.String (fun filename -> if Sys.file_exists filename
@@ -370,6 +367,9 @@ let short_options = [ "--use-coccigrep", Arg.Unit (function _ -> Flag.scanner := Flag.CocciGrep), " find relevant files using cocci grep"; + "--use-patchdiff", + Arg.Unit (function _ -> Flag.scanner := Flag.PatchDiff), + " process files in the diff for a directory"; "--patch", Arg.String (function s -> Flag.patch := Some (Cocci.normalize_path s)), (" <dir> path name with respect to which a patch should be created\n"^
@@ -940,13 +940,18 @@ let idutils_filter (_,_,_,query) dir = Some (files +> List.filter - (fun file -> List.mem (Common.filesuffix file) suffixes)) + (fun file -> List.mem (Common.filesuffix file) suffixes)) + +let patchdiff_filter _ dir = + let struc = Patch_diff.getpatchdiff dir in + Some (List.map (function x -> x.Patch_diff.file_name) struc) let scanner_to_interpreter = function Flag.Glimpse -> glimpse_filter | Flag.IdUtils -> idutils_filter | Flag.CocciGrep -> coccigrep_filter | Flag.GitGrep -> gitgrep_filter + | Flag.PatchDiff -> patchdiff_filter | _ -> failwith "impossible" (*****************************************************************************)
@@ -1079,7 +1084,7 @@ let rec main_action xs = " or multiple files") | _, false, _, _, _ -> [List.map (fun x -> (x,None)) (x::xs)] | _, true, "", - (Flag.Glimpse|Flag.IdUtils|Flag.CocciGrep|Flag.GitGrep), + (Flag.Glimpse|Flag.IdUtils|Flag.CocciGrep|Flag.GitGrep|Flag.PatchDiff), [] -> let interpreter = scanner_to_interpreter !Flag.scanner in let files =
@@ -1088,7 +1093,7 @@ let rec main_action xs = | Some files -> files in files +> List.map (fun x -> [(x,None)]) | _, true, s, - (Flag.Glimpse|Flag.IdUtils|Flag.CocciGrep|Flag.GitGrep), _ + (Flag.Glimpse|Flag.IdUtils|Flag.CocciGrep|Flag.GitGrep|Flag.PatchDiff), _ when s <> "" -> failwith "--use-xxx filters do not work with --kbuild" (* normal *)
globals/flag.ml +1 -1
@@ -16,7 +16,7 @@ let track_iso_usage = ref false let worth_trying_opt = ref true -type scanner = IdUtils | Glimpse | CocciGrep | GitGrep | NoScanner +type scanner = IdUtils | Glimpse | CocciGrep | GitGrep | PatchDiff | NoScanner let scanner = ref NoScanner let pyoutput = ref "coccilib.output.Console"
globals/flag.mli +1 -1
@@ -4,7 +4,7 @@ val show_transinfo : bool ref val show_trying : bool ref val track_iso_usage : bool ref val worth_trying_opt : bool ref -type scanner = IdUtils | Glimpse | CocciGrep | GitGrep | NoScanner +type scanner = IdUtils | Glimpse | CocciGrep | GitGrep | PatchDiff | NoScanner val scanner : scanner ref val pyoutput : string ref val ocamlc : string ref
ocaml/coccilib.mli +1 -0
@@ -1372,6 +1372,7 @@ module Flag : | Glimpse | CocciGrep | GitGrep + | PatchDiff | NoScanner val scanner : scanner ref val pyoutput : string ref
parsing_cocci/get_constants2.ml +1 -0
@@ -866,5 +866,6 @@ let get_constants rules neg_pos_vars virt = | Flag.IdUtils -> (grep,None,coccigrep,interpret_idutils res) | Flag.CocciGrep | Flag.GitGrep -> (grep,None,coccigrep,None) + | Flag.PatchDiff -> (None, None, None, None) end else (None,None,None,None)
parsing_cocci/patch_diff.ml new file +118 -0
118 lines not on this page · raw message
parsing_cocci/patch_diff.mli new file +9 -0
@@ -0,0 +1,9 @@ + + +type diff_info = +{ + file_name: string; + line_no: (int * int) list; +} + +val getpatchdiff : string -> diff_info list
Signature · 6 lines
2.31.1 _______________________________________________ Cocci mailing list [email protected] https://systeme.lip6.fr/mailman/listinfo/cocci
PATCH 2/2 docs: manual: Add option description in spatch_options
In reply to Sumera PriyadarsiniAdd documentation for the "use-patchdiff" option introduced in the first patch of this patchset. This option allows for applying a semantic patch to only those files in a directory where code additions have been made.
--- docs/manual/spatch_options.tex | 5 +++++ 1 file changed, 5 insertions(+)
docs/manual/spatch_options.tex +5 -0
@@ -217,6 +217,11 @@ intereted relative to the target directory. If the filename is an absolute path name, beginning with /, it is used as is. } +\normal{-{}-use-patchdiff}{ This option allows for applying a semantic patch + to only the files that have been modified in a directory. The directory needs + to be specified by the user. Note that an absolute path needs to be used if + spatch is called from outside the target project directory. } + \normal{-{}-use-coccigrep}{ Use a version of grep implemented in Coccinelle to check that selected files are relevant to the semantic patch. This option is only relevant to the case of working on a complete directory,
Signature · 6 lines
2.31.1 _______________________________________________ Cocci mailing list [email protected] https://systeme.lip6.fr/mailman/listinfo/cocci
Quoted 7 lines
This patchset adds a feature to enable Coccinelle to only check all those files in a directory which were modified. It parses all the files obtained from the output of "git diff" and checks them against the specified cocci script.
An example for passing the "use-patchdiff" option is:
How do you think about to use the parameter name “use-files-from-diff”?
Regards,
Markus
_______________________________________________
Cocci mailing list
[email protected]
https://systeme.lip6.fr/mailman/listinfo/cocci
Quoted 10 lines · Markus Elfring
Quoted 8 lines
This patchset adds a feature to enable Coccinelle to only check all those files in a directory which were modified. It parses all the files obtained from the output of "git diff" and checks them against the specified cocci script.
An example for passing the "use-patchdiff" option is:
How do you think about to use the parameter name “use-files-from-diff”?
I would prefer something shorter, like "use-filesdiff" but I am okay with either name as
long as the maintainers are okay with it. :)
Julia, what do you think? I will send a v2 with any of the above name options (and/or any other changes that are suggested.)
Thanks,
Sumera
Quoted 3 lines
Regards,
Markus
_______________________________________________
Cocci mailing list
[email protected]
https://systeme.lip6.fr/mailman/listinfo/cocci
Quoted 10 lines · Sumera Priyadarsini
Quoted 9 lines · Markus Elfring
Quoted 8 lines
This patchset adds a feature to enable Coccinelle to only check all those files in a directory which were modified. It parses all the files obtained from the output of "git diff" and checks them against the specified cocci script.
An example for passing the "use-patchdiff" option is:
Quoted 8 lines
Quoted 1 line
How do you think about to use the parameter name “use-files-from-diff”?
I would prefer something shorter, like "use-filesdiff" but I am okay with either name as
long as the maintainers are okay with it. :)Julia, what do you think? I will send a v2 with any of the above name options (and/or any other changes that are suggested.)
I think that shorter names are better. The current name could be ok, but a - between patch and diff might be more natural.
julia
_______________________________________________
Cocci mailing list
[email protected]
https://systeme.lip6.fr/mailman/listinfo/cocci