From 47b9f44d67539fed3fc534a22ea999d47d656417 Mon Sep 17 00:00:00 2001
From: Simmo Saan <simmo.saan@gmail.com>
Date: Fri, 28 Jun 2024 12:09:47 +0300
Subject: [PATCH] Add package description (closes #1528)

---
 dune-project        | 5 +++++
 goblint.opam        | 5 +++++
 goblint.opam.locked | 4 ++++
 3 files changed, 14 insertions(+)

diff --git a/dune-project b/dune-project
index b85a82b93f..f07ccf4236 100644
--- a/dune-project
+++ b/dune-project
@@ -22,6 +22,11 @@
 (package
   (name goblint)
   (synopsis "Static analysis framework for C")
+  (description "\
+Goblint is a sound static analysis framework for C programs using abstract interpretation.
+It specializes in thread-modular verification of multi-threaded programs, especially regarding data races.
+Goblint includes analyses for assertions, overflows, deadlocks, etc and can be extended with new analyses.
+")
   (depends
     (ocaml (>= 4.14))
     (goblint-cil (>= 2.0.3)) ; TODO no way to define as pin-depends? Used goblint.opam.template to add it for now. https://github.com/ocaml/dune/issues/3231. Alternatively, removing this line and adding cil as a git submodule and `(vendored_dirs cil)` as ./dune also works. This way, no more need to reinstall the pinned cil opam package on changes. However, then cil is cleaned and has to be rebuild together with goblint.
diff --git a/goblint.opam b/goblint.opam
index 03e11d456a..eec74439a0 100644
--- a/goblint.opam
+++ b/goblint.opam
@@ -1,6 +1,11 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
 synopsis: "Static analysis framework for C"
+description: """
+Goblint is a sound static analysis framework for C programs using abstract interpretation.
+It specializes in thread-modular verification of multi-threaded programs, especially regarding data races.
+Goblint includes analyses for assertions, overflows, deadlocks, etc and can be extended with new analyses.
+"""
 maintainer: [
   "Simmo Saan <simmo.saan@gmail.com>"
   "Michael Schwarz <michael.schwarz93@gmail.com>"
diff --git a/goblint.opam.locked b/goblint.opam.locked
index 0cf9a2ff75..90bfba68f0 100644
--- a/goblint.opam.locked
+++ b/goblint.opam.locked
@@ -143,3 +143,7 @@ pin-depends: [
   ]
 ]
 depexts: ["libgraph-easy-perl"] {os-distribution = "ubuntu" & with-test}
+description: """\
+Goblint is a sound static analysis framework for C programs using abstract interpretation.
+It specializes in thread-modular verification of multi-threaded programs, especially regarding data races.
+Goblint includes analyses for assertions, overflows, deadlocks, etc and can be extended with new analyses."""