Commit Graph

65 Commits

Author SHA1 Message Date
David A. Wheeler 2b8c890467 flawfinder.1: minor reformatting
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2021-05-30 19:05:39 -04:00
David A. Wheeler 428fbf6b02 Make --error-level more obvious in the man page
The --error-level option is useful in continuous integration (CI)
pipelines. Make it even more obvious in the documentation.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2021-05-30 19:03:37 -04:00
David A. Wheeler 113483d06b flawfinder.1: Minor man page cleanup
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2021-05-30 18:56:28 -04:00
David A. Wheeler bcb5e652ef Document SARIF defails in man page
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2021-05-30 18:46:50 -04:00
David A. Wheeler 293ca17d82 Note character encoding in README, note cvt2utf
To help people out, note the potential character encoding issue
in the README (pointing to the documentation for more details)
and note the "cvt2utf" Python program.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2019-10-24 08:22:59 -04:00
David A. Wheeler f1fdd59da5 Improve docs on character encoding
Provide better info on how to handle character encoding problems.
As more people use Python3 this is more likely to be a problem.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2019-09-22 15:21:11 -04:00
David A. Wheeler 530a88a395 Change www.dwheeler.com to dwheeler.com
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2018-09-30 21:35:11 -04:00
David A. Wheeler 54039e0bd5 Fix flawfinder man page (e.g., fix the title of my book)
This fixes bug #11, see:
https://sourceforge.net/p/flawfinder/bugs/11/

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2018-04-04 11:31:07 -04:00
David A. Wheeler d7ce082024 Add "--error-level" option for continuous integration systems
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2018-01-27 18:11:52 -05:00
David A. Wheeler 2691ac6de5 Use https:, not http:, for cwe.mitre.org
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2018-01-25 23:52:35 -05:00
David A. Wheeler f91e3ea60b Note in man page that the extension .c++ is supported
This fixes SF bug #10.

My thanks to philipp for reporting this.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2018-01-25 23:40:36 -05:00
David A. Wheeler 90269a2c75 Add documentation about #if, #ifdef, and #if 0
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-09-24 22:50:10 -04:00
David A. Wheeler 5aa1dec7f7 Update www.dwheeler.com URLs to use https
The www.dwheeler.com site has long supported https, but I forgot
to change these URLs. Fix that, so that people will use https.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-09-23 20:45:03 -04:00
David A. Wheeler cead0828ef Add documentation about encoding
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 17:51:27 -04:00
David A. Wheeler 09c14ab42d Note Python versioning issues with pickle in flawfinder.1 man page.
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 16:51:17 -04:00
David A. Wheeler b2556b7348 Add some warnings about -P to help users use it properly
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 15:52:04 -04:00
David A. Wheeler 203115edc3 Update book title
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 15:28:22 -04:00
David A. Wheeler 58e56cad03 Minor update of man page
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-08-26 14:55:09 -04:00
David A. Wheeler f9d6e11cdf Document CSV format further, including the fingerprint
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 23:56:09 -04:00
David A. Wheeler 41ccb9c0ef Add CSV option as a documented example
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 23:39:04 -04:00
David A. Wheeler 5ad5a17034 Make minor improvements to flawfinder man page
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 23:29:36 -04:00
David A. Wheeler 51208ff35b Document the --csv option in the man page and pdf
The CSV option is noted in the ChangeLog, and is explained in --help,
but I forgot to add it to the man page.  This fixes the man page
and its corresponding generated PDF file.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-30 23:23:18 -04:00
David A. Wheeler 872109f230 Change version number to 2.0.0 - use Semantic Versioning
This switches flawfinder's version naming conventions to comply with
Semantic Versioning.  We change the first digit to "2" because
there's a subtle change in how CWEs are reported - see the
ChangeLog or documentation for more information.

Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
2017-07-29 13:24:25 -04:00
David A. Wheeler dc04172c52 flawfinder.1: Note that .makepp is also skipped by default 2014-09-07 14:14:34 -04:00
David A. Wheeler 94a20df2ee flawfinder.1: Tweak documentation about flag syntax 2014-09-07 14:05:52 -04:00
David A. Wheeler aa2277b862 Add Microsoft banned functions for string copy and replacement 2014-08-09 13:32:37 -04:00
David A. Wheeler 0b432d2791 Change syntax of CWE mapping reports for CWE hierarchies (use "!" for map)
- The old syntax was very confusing.  Now just report
    higher-level/lower-level, with "!" after the CWE that is actually
    the mapping.
2014-08-09 13:06:50 -04:00
David A. Wheeler 0d56338062 flawfinder.1: Fix typo 2014-08-04 22:49:19 -04:00
David A. Wheeler 36b513af7c flawfinder.1: Update manual page date 2014-08-03 14:53:10 -04:00
David A. Wheeler 2c383e37a7 flawfinder.1: Note that .git and .svn are examples of directories skipped 2014-08-03 13:17:43 -04:00
David A. Wheeler 7727f10dce flawfinder.1: Trivial reformat 2014-08-02 22:25:20 -04:00
David A. Wheeler 4159de084a Document how to find all patterns that do NOT have a CWE mapping. 2014-08-02 22:05:23 -04:00
David A. Wheeler f05aa1270e flawfinder.1: Grammar fix 2014-08-02 21:56:19 -04:00
David A. Wheeler 8f9ccc47ea Add option "-H" as a synonym for "--html" to generate HTML 2014-08-02 21:50:21 -04:00
David A. Wheeler 4c36be0094 Reorder help information, help and version are really common requests 2014-08-02 21:46:29 -04:00
David A. Wheeler 24b7da535b flawfinder.1: Minor doc cleanups. Note that --listrules works with -D 2014-08-02 21:39:36 -04:00
David A. Wheeler 3b2f032f25 flawfinder.1: Specially document -QDSC example (useful for tool writers) 2014-08-02 21:07:42 -04:00
David A. Wheeler d769867375 Clearly document the license (GPLv2+) 2014-07-28 21:58:22 -04:00
David A. Wheeler 7020a47a3e flawfinder.1: Tweak output so 80-column version looks okay 2014-07-28 21:13:04 -04:00
David A. Wheeler 1ebc5d5afb Note that flawfinder is CWE-compatible. 2014-07-27 17:16:56 -04:00
David A. Wheeler a33ae6c62e Add more wide character rules and refine CWE mapping 2014-07-22 23:17:53 -04:00
David A. Wheeler bbe7a28ada flawfinder.1: Clean up man page, esp. option description 2014-07-21 00:00:12 -04:00
David A. Wheeler 564b78b98d flawfinder.1: Document that hitlists should be trusted to be loaded or diffed 2014-07-19 20:42:37 -04:00
David A. Wheeler 8423c14116 Fix up "make show-cwes" 2014-07-19 19:21:23 -04:00
David A. Wheeler cfe1a062fe Tweak mappings to CWE. strlen() better maps to CWE-126 (buffer over-read) 2014-07-19 19:05:49 -04:00
David A. Wheeler e0c0b9bc8e flawfinder.1: Minor documentation improvements, including removing blank lines 2014-07-19 18:38:24 -04:00
David A. Wheeler 4156a4199c flawfinder.1: Refine man page (esp. CWE discussion) 2014-07-19 17:23:10 -04:00
David A. Wheeler a7a7bb349b Modify documentation for listrules, and add CWE mapping info 2014-07-19 12:58:15 -04:00
David A. Wheeler dcf7c7ff40 flawfinder.1: Expand CWE description and make other small improvements 2014-07-13 15:05:55 -04:00
David A. Wheeler 622add482e flawfinder.1: Minor tweaks 2014-07-13 13:49:51 -04:00