Update organization.txt

.gitignore

@@ -9,6 +9,9 @@ target/
 *.lcov
 *.profraw
 
+# Clang
+.clangd
+
 # Rust
 **/Cargo.lock
 

CONTRIBUTING.md

@@ -12,17 +12,9 @@ behaviors of various common development environments like emacs.
 
 ### Organization
 
-- Please avoid cluttering the repository root
-- `.github`: CI- and repo-related config
-- `config`: GNU Make build system config
-- `contrib`: Miscellaneous code
-- `ffi/rust`: Rust FFI bindings
-- `src`: Main source tree
-  - `app`: Main programs
-  - `ballet`: Protocol-related code (parsers, serializers, cryptography)
-  - `disco`: Tiles
-  - `tango`: Concurrency-related code (message queues, I/O)
-  - `util`: Firedancer standard library
+See [organization.txt](./doc/organization.txt).
+
+Please avoid cluttering the repository root.
 
 ### File Extensions
 

doc/organization.txt

@@ -2,9 +2,12 @@ Firedancer source tree
 
   firedancer/
   │
+  ├── .github/         GitHub CI configuration
+  │
   ├── build/                   Build artifacts
   │   └── linux/gcc/x86_64     Build profile
   │       ├── bin/             Main programs and scripts
+  │       ├── cov/             Coverage report
   │       ├── include/         Exported include headers
   │       ├─  lib/             Static libraries
   │       ├── obj/             Object files of individual compile units
@@ -13,29 +16,53 @@ Firedancer source tree
   ├── config/          GNU Make configuration
   │
   ├── contrib/         Miscellaneous developer tooling
+  │   ├── codegen/     Scripts used to generate code
+  │   ├── docker/      Reference container configuration
+  │   ├── test/        Scripts used to run tests
+  │   └── tool/        Config files for developer tools
   │
   ├── opt/
   │   ├── git/         Third-party dependency repos
   │   ├── include/     Third-party dependency headers
   │   └── lib/         Third-party dependency libraries
   │
-  └── src/             The main Firedancer source tree
-      │
-      ├── app/         Main binaries
-      │
-      ├── ballet/      Standalone implementations of various standards
-      │                needed for interoperability with the Solana ecosystem
-      │                (hash functions, cryptographic algorithms)
-      │
-      ├── disco/       Tiles running on the tango messaging layer
-      │
-      ├── flamenco/    Major Solana runtime and consensus components
-      │                (bank, leader schedule, virtual machine, ...)
-      │
-      ├── funk/        Database optimized for storing Solana ledger and
-      │                accounts
-      │
-      ├── tango/       IPC messaging layer and networking
-      │
-      └── util/        C language environment, system runtime, common data
-                       structures and various utilities (math, bits, rng ...)
+  ├── src/             The main Firedancer source tree
+  │   │
+  │   ├── app/         Main binaries
+  │   │
+  │   ├── ballet/      Standalone implementations of various standards
+  │   │                needed for interoperability with the Solana ecosystem
+  │   │                (hash functions, cryptographic algorithms)
+  │   │
+  │   ├── disco/       Tiles running on the tango messaging layer
+  │   │
+  │   ├── flamenco/    Major Solana runtime and consensus components
+  │   │                (bank, leader schedule, virtual machine, ...)
+  │   │
+  │   ├── funk/        Database optimized for storing Solana ledger and
+  │   │                accounts
+  │   │
+  │   ├── tango/       IPC messaging layer and networking
+  │   │
+  │   └── util/        C language environment, system runtime, common data
+  │                    structures and various utilities (math, bits, rng ...)
+  │
+  └── verification/    CBMC-based code verification system
+
+Important files
+
+  README.md
+
+  # Prepare external dependencies
+  deps.sh
+
+  # Test launchers
+  contrib/test/run_unit_tests.sh
+  contrib/test/run_script_tests.sh
+  contrib/test/run_integration_tests.sh
+
+  # All-in-one test launcher
+  contrib/test/ci_tests.sh
+
+  # Licensing information for imported third-party code
+  NOTICE