Mention "git diff"

This commit is contained in:
David A. Wheeler 2014-07-12 21:06:45 -04:00
parent 9dda4624dc
commit 7ebfb3bbb6
1 changed files with 8 additions and 5 deletions

View File

@ -69,8 +69,8 @@ Thus, for most projects, simply give flawfinder the name of the source
code's topmost directory (use ``.'' for the current directory), code's topmost directory (use ``.'' for the current directory),
and flawfinder will examine all of the project's C/C++ source code. and flawfinder will examine all of the project's C/C++ source code.
If you only want to have \fIchanges\fR reviewed, save a unified diff If you only want to have \fIchanges\fR reviewed, save a unified diff
of those changes (created by "diff -u" or "svn diff") in a patch file of those changes (created by "diff -u" or "svn diff" or "git diff")
and use the \-\-patch (\-P) option. in a patch file and use the \-\-patch (\-P) option.
.PP .PP
Flawfinder will produce a list of ``hits'' (potential Flawfinder will produce a list of ``hits'' (potential
security flaws), sorted by risk; the riskiest hits are shown first. security flaws), sorted by risk; the riskiest hits are shown first.
@ -342,10 +342,12 @@ behavior is now the default.
.TP 12 .TP 12
.BI \-\-patch patchfile .BI \-\-patch patchfile
.TP
.BI \-P patchfile .BI \-P patchfile
Only report hits that are changed by the given patch file. Only report hits that are changed by the given patch file.
The patch file must be in unified diff format (e.g., the output of The patch file must be in unified diff format (e.g., the output of
"diff -u old new" or "svn diff"), where the new files are the ones that are "diff -u old new", "svn diff", or "git diff"),
where the new files are the ones that are
being examined by flawfinder. being examined by flawfinder.
The line numbers given in the patch file are used to determine which The line numbers given in the patch file are used to determine which
lines were changed, so if you have modified the files since the lines were changed, so if you have modified the files since the
@ -354,8 +356,9 @@ Beware that the file names of the new files
given in the patch file must match exactly, given in the patch file must match exactly,
including upper/lower case, path prefix, and directory including upper/lower case, path prefix, and directory
separator (\\ vs. /). separator (\\ vs. /).
Only unified diff format is accepted (either GNU diff or svn diff output is Only unified diff format is accepted (GNU diff, svn diff, and
okay); if you have a different format, again regenerate it first. git diff output is okay);
if you have a different format, again regenerate it first.
Only hits that occur on resultant changed lines, or immediately Only hits that occur on resultant changed lines, or immediately
above and below them, are reported. above and below them, are reported.
This option implies \-\-neverignore. This option implies \-\-neverignore.