Skip to content

Commit

Permalink
add section about ignore files
Browse files Browse the repository at this point in the history
  • Loading branch information
boyter committed Aug 3, 2020
1 parent d9ebb10 commit 09448a6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,10 @@ Note that you don't have to specify the directory you want to run against. Runni

You can also run against multiple files or directories `scc directory1 directory2 file1 file2` with the results aggregated in the output.

### Ignore Files

`scc` mostly supports .ignore files inside directories that it scans. This is similar to how ripgrep, ag and tokei work. .ignore files are 100% the same as .gitignore files with the same syntax, and as such `scc` will ignore files and directories listed in them. You can add .ignore files to ignore things like vendored dependency checked in files and such. The idea is allowing you to add a file or folder to git and have ignored in the count.

### Interesting Use Cases

Used inside Intel Nemu Hypervisor to track code changes between revisions https://github.com/intel/nemu/blob/topic/virt-x86/tools/cloc-change.sh#L9
Expand Down

0 comments on commit 09448a6

Please sign in to comment.