apache / kvrocks
Source Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope
Files includes and excluded from analyses
txt
lua
mod
in
clang-format
clang-tidy
Overview of Analyzed Files
Basic stats on analyzed files
Intro
For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.

  • The main category contains all manually created source code files that are being used in the production.
  • Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
  • Test source code files are used only for testing of the product. These files are normally not deployed to production.
  • Build and deployment source code files are used to configure or support build and deployment process.
  • Generated source code files are automatically generated files that have not been manually changed after generation.
  • While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
  • Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.

main48124 LOC (57%) 272 files
test34984 LOC (41%) 127 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other938 LOC (1%) 24 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
in
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 272 files match defined criteria (48,124 LOC, 100.0% vs. main code):
    • 99 *.cc files (35,213 LOC)
    • 142 *.h files (11,643 LOC)
    • 29 *.cmake files (898 LOC)
    • 1 *.py files (347 LOC)
    • 1 *.in files (23 LOC)
  • " *.cc" is biggest, containing 73.17% of LOC.
  • " *.in" is smallest, containing 0.05% of LOC.


*.cc35213 LOC (73%) 99 files
*.h11643 LOC (24%) 142 files
*.cmake898 LOC (1%) 29 files
*.py347 LOC (<1%) 1 file
*.in23 LOC (<1%) 1 file
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
lua
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/test_.*".
  • 127 files match defined criteria (34,984 LOC, 72.7% vs. main code):
    • 72 *.go files (23,142 LOC)
    • 48 *.cc files (11,367 LOC)
    • 2 *.py files (237 LOC)
    • 2 *.h files (211 LOC)
    • 3 *.lua files (27 LOC)
  • " *.go" is biggest, containing 66.15% of LOC.
  • " *.lua" is smallest, containing 0.08% of LOC.


*.go23142 LOC (66%) 72 files
*.cc11367 LOC (32%) 48 files
*.py237 LOC (<1%) 2 files
*.h211 LOC (<1%) 2 files
*.lua27 LOC (<1%) 3 files
Other Code
txt
mod
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/vendor/.*".
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]dockerignore".
  • 24 files match defined criteria (938 LOC, 1.9% vs. main code):
    • 19 *.txt files (715 LOC)
    • 4 *.md files (198 LOC)
    • 1 *.mod files (25 LOC)
  • " *.txt" is biggest, containing 76.23% of LOC.
  • " *.mod" is smallest, containing 2.67% of LOC.


*.txt715 LOC (76%) 19 files
*.md198 LOC (21%) 4 files
*.mod25 LOC (2%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2025-05-07 19:57