Improve architecture document

- framework -> core
- Describe source code directories in a section of their own.

diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md
index e8e89208109843d4171149d83b568a3a88660d20..20292bf1bef03c7057f4289be5d590bd0f2af168 100644 (file)
--- a/ARCHITECTURE.md
+++ b/ARCHITECTURE.md
@@ -2,9 +2,7 @@
 
 ## Code structure
 
-The ccache code base has grown organically through the years. This section
-describes the directory structure that the project aims to transform the source
-code into in the long run to make it easier to understand and work with.
+### Top-level directories
 
 * `ci`: Utility scripts used in CI.
 * `cmake`: CMake scripts.
@@ -12,18 +10,26 @@ code into in the long run to make it easier to understand and work with.
 * `dockerfiles`: Dockerfiles that specify different environments of interest for
   ccache.
 * `misc`: Miscellaneous utility scripts, example files, etc.
-* `src/compiler`: Knowledge about things like compiler options, compiler
-  behavior, preprocessor output format, etc. Ideally this code should in the
-  future be refactored into compiler-specific frontends, such as GCC, Clang,
-  MSVC, etc.
-* `src/compression`: Compression formats.
-* `src/framework`: Everything not part of other directories.
-* `src/storage`: Storage backends.
-* `src/storage/primary`: Code for the primary storage backend.
-* `src/storage/secondary`: Code for secondary storage backends.
-* `src/third_party`: Bundled third party code.
-* `src/util`: Generic utility functionality that does not depend on
-  ccache-specific things.
+* `src`: Source code. See below.
 * `test`: Integration test suite which tests the ccache binary in different
   scenarios.
 * `unittest`: Unit test suite which typically tests individual functions.
+
+### Subdirectories of `src`
+
+This section describes the directory structure that the project aims to
+transform the `src` directory into in the long run to make the code base easier
+to understand and work with. In other words, this is work in progress.
+
+* `compiler`: Knowledge about things like compiler options, compiler behavior,
+  preprocessor output format, etc. Ideally this code should in the future be
+  refactored into compiler-specific frontends, such as GCC, Clang, NVCC, MSVC,
+  etc.
+* `compression`: Compression formats.
+* `core`: Everything not part of other directories.
+* `storage`: Storage backends.
+* `storage/primary`: Code for the primary storage backend.
+* `storage/secondary`: Code for secondary storage backends.
+* `third_party`: Bundled third party code.
+* `util`: Generic utility functionality that does not depend on ccache-specific
+  things.