Extract configuration to goblint_config dune library

sim642 · sim642 · commit 54d7fdf5dd0f · 2023-12-06T17:08:30.000+02:00
diff --git a/.github/workflows/options.yml b/.github/workflows/options.yml
@@ -26,10 +26,10 @@ jobs:
         run: npm install -g ajv-cli
 
       - name: Migrate schema # https://github.com/ajv-validator/ajv-cli/issues/199
-        run: ajv migrate -s src/common/util/options.schema.json
+        run: ajv migrate -s src/config/options.schema.json
 
       - name: Validate conf
-        run: ajv validate -s src/common/util/options.schema.json -d "conf/**/*.json"
+        run: ajv validate -s src/config/options.schema.json -d "conf/**/*.json"
 
       - name: Validate incremental tests
-        run: ajv validate -s src/common/util/options.schema.json -d "tests/incremental/*/*.json"
+        run: ajv validate -s src/config/options.schema.json -d "tests/incremental/*/*.json"
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -20,4 +20,4 @@ build:
       - pip install json-schema-for-humans
     post_build:
       - mkdir _readthedocs/html/jsfh/
-      - generate-schema-doc --config-file jsfh.yml src/common/util/options.schema.json _readthedocs/html/jsfh/
+      - generate-schema-doc --config-file jsfh.yml src/config/options.schema.json _readthedocs/html/jsfh/
diff --git a/docs/user-guide/configuring.md b/docs/user-guide/configuring.md
@@ -24,7 +24,7 @@ In `.vscode/settings.json` add the following:
                 "/conf/*.json",
                 "/tests/incremental/*/*.json"
             ],
-            "url": "/src/common/util/options.schema.json"
+            "url": "/src/config/options.schema.json"
         }
     ]
 }
diff --git a/src/common/common.mld b/src/common/common.mld
@@ -18,14 +18,6 @@ AnalysisState
 ControlSpecC
 }
 
-{2 Configuration}
-{!modules:
-GobConfig
-AfterConfig
-JsonSchema
-Options
-}
-
 
 {1 Domains}
 {!modules:
diff --git a/src/common/dune b/src/common/dune
@@ -8,23 +8,18 @@
    batteries.unthreaded
    zarith
    goblint_std
+   goblint_config
    goblint_tracing
    goblint-cil
    fpath
    yojson
-   json-data-encoding
-   cpu
    goblint_timing
-   goblint_build_info
-   goblint.sites
    qcheck-core.runner)
  (flags :standard -open Goblint_std)
  (preprocess
   (pps
     ppx_deriving.std
     ppx_deriving_hash
-    ppx_deriving_yojson
-    ppx_blob))
- (preprocessor_deps (file util/options.schema.json)))
+    ppx_deriving_yojson)))
 
 (documentation)
diff --git a/src/config/afterConfig.ml b/src/config/afterConfig.ml
diff --git a/src/config/config.mld b/src/config/config.mld
@@ -0,0 +1,14 @@
+{0 Library goblint.config}
+This library is unwrapped and provides the following top-level modules.
+For better context, see {!Goblint_lib} which also documents these modules.
+
+
+{1 Framework}
+
+{2 Configuration}
+{!modules:
+GobConfig
+AfterConfig
+JsonSchema
+Options
+}
diff --git a/src/config/dune b/src/config/dune
@@ -0,0 +1,23 @@
+(include_subdirs unqualified)
+
+(library
+ (name goblint_config)
+ (public_name goblint.config)
+ (wrapped false) ; TODO: wrap
+ (libraries
+   batteries.unthreaded
+   goblint_std
+   goblint_tracing
+   fpath
+   yojson
+   json-data-encoding
+   cpu
+   goblint.sites
+   qcheck-core.runner)
+ (flags :standard -open Goblint_std)
+ (preprocess
+  (pps
+    ppx_blob))
+ (preprocessor_deps (file options.schema.json)))
+
+(documentation)
diff --git a/src/config/gobConfig.ml b/src/config/gobConfig.ml
diff --git a/src/config/jsonSchema.ml b/src/config/jsonSchema.ml
diff --git a/src/config/options.ml b/src/config/options.ml
@@ -1,4 +1,4 @@
-(** [src/common/util/options.schema.json] low-level access. *)
+(** [src/config/options.schema.json] low-level access. *)
 
 open Json_schema
 
diff --git a/src/config/options.schema.json b/src/config/options.schema.json
diff --git a/src/dune b/src/dune
@@ -7,7 +7,7 @@
   (name goblint_lib)
   (public_name goblint.lib)
   (modules :standard \ goblint privPrecCompare apronPrecCompare messagesCompare)
-  (libraries goblint.sites goblint.build-info goblint-cil.all-features batteries.unthreaded qcheck-core.runner sha json-data-encoding jsonrpc cpu arg-complete fpath yaml yaml.unix uuidm goblint_timing catapult goblint_backtrace fileutils goblint_std goblint_common goblint_domain goblint_tracing
+  (libraries goblint.sites goblint.build-info goblint-cil.all-features batteries.unthreaded qcheck-core.runner sha json-data-encoding jsonrpc cpu arg-complete fpath yaml yaml.unix uuidm goblint_timing catapult goblint_backtrace fileutils goblint_std goblint_config goblint_common goblint_domain goblint_tracing
     ; Conditionally compile based on whether apron optional dependency is installed or not.
     ; Alternative dependencies seem like the only way to optionally depend on optional dependencies.
     ; See: https://dune.readthedocs.io/en/stable/concepts.html#alternative-dependencies.
diff --git a/src/goblint_lib.ml b/src/goblint_lib.ml
@@ -51,7 +51,7 @@ module VarQuery = VarQuery
 (** {2 Configuration}
 
     Runtime configuration is represented as JSON.
-    Options are specified and documented by the JSON schema [src/common/util/options.schema.json]. *)
+    Options are specified and documented by the JSON schema [src/config/options.schema.json]. *)
 
 module GobConfig = GobConfig
 module AfterConfig = AfterConfig
diff --git a/src/index.mld b/src/index.mld
@@ -7,6 +7,9 @@ The following libraries make up Goblint's main codebase.
 {!modules:Goblint_lib}
 This library currently contains the majority of Goblint and is in the process of being split into smaller libraries.
 
+{2 Library goblint.config}
+This {{!page-config}unwrapped library} contains various configuration modules extracted from {!Goblint_lib}.
+
 {2 Library goblint.common}
 This {{!page-common}unwrapped library} contains various common modules extracted from {!Goblint_lib}.
 

Original file line number	Diff line number	Diff line change
@@ -24,7 +24,7 @@ In `.vscode/settings.json` add the following:
`24`	`24`	`"/conf/*.json",`
`25`	`25`	`"/tests/incremental//.json"`
`26`	`26`	`],`
`27`		`- "url": "/src/common/util/options.schema.json"`
	`27`	`+ "url": "/src/config/options.schema.json"`
`28`	`28`	`}`
`29`	`29`	`]`
`30`	`30`	`}`