Add opam template file and configure more fields

vcs-base.opam

@@ -40,3 +40,25 @@ build: [
   ]
 ]
 dev-repo: "git+https://github.com/mbarbin/vcs.git"
+description: """\
+
+[Vcs_base] is a library that extends the [Vcs] library with additional
+modules and functionalities to improve compatibility with programs
+using [base].
+
+For example, it adds [Comparable.S] to all container key modules so
+that they can be used with [base]-style containers such as [Map] and
+[Hashtbl].
+
+It also exports a module [Vcs.Or_error] to make it easy to use [Vcs]
+with the [Or_error] monad.
+
+The library is designed to be used as a drop-in replacement for [Vcs].
+To achieve this, it includes a single module named [Vcs] which must be
+set up to shadow the regular [Vcs] module.
+
+[base]: https://github.com/janestreet/base
+
+"""
+tags: [ "git" "vcs" "base" ]
+x-maintenance-intent: [ "(latest)" ]

vcs-base.opam.template

@@ -0,0 +1,22 @@
+description: """\
+
+[Vcs_base] is a library that extends the [Vcs] library with additional
+modules and functionalities to improve compatibility with programs
+using [base].
+
+For example, it adds [Comparable.S] to all container key modules so
+that they can be used with [base]-style containers such as [Map] and
+[Hashtbl].
+
+It also exports a module [Vcs.Or_error] to make it easy to use [Vcs]
+with the [Or_error] monad.
+
+The library is designed to be used as a drop-in replacement for [Vcs].
+To achieve this, it includes a single module named [Vcs] which must be
+set up to shadow the regular [Vcs] module.
+
+[base]: https://github.com/janestreet/base
+
+"""
+tags: [ "git" "vcs" "base" ]
+x-maintenance-intent: [ "(latest)" ]

vcs-command.opam

@@ -41,3 +41,20 @@ build: [
   ]
 ]
 dev-repo: "git+https://github.com/mbarbin/vcs.git"
+description: """\
+
+[vcs-command] is a package from the [vcs] project that provides a
+command-line interface called [ocaml-vcs]. This interface is
+implemented on top of the other packages from the project.
+
+It allows users to run exploratory tests using the [vcs] interface and
+the Git backends available on actual repositories, directly from the
+command line.
+
+This tool can be helpful for reproducing issues with the library or
+getting familiar with some functionality of the project in an
+interactive fashion using real live data.
+
+"""
+tags: [ "cli" "git" "ocaml-vcs" "vcs" ]
+x-maintenance-intent: [ "(latest)" ]

vcs-command.opam.template

@@ -0,0 +1,17 @@
+description: """\
+
+[vcs-command] is a package from the [vcs] project that provides a
+command-line interface called [ocaml-vcs]. This interface is
+implemented on top of the other packages from the project.
+
+It allows users to run exploratory tests using the [vcs] interface and
+the Git backends available on actual repositories, directly from the
+command line.
+
+This tool can be helpful for reproducing issues with the library or
+getting familiar with some functionality of the project in an
+interactive fashion using real live data.
+
+"""
+tags: [ "cli" "git" "ocaml-vcs" "vcs" ]
+x-maintenance-intent: [ "(latest)" ]

vcs-git-blocking.opam

@@ -37,3 +37,18 @@ build: [
   ]
 ]
 dev-repo: "git+https://github.com/mbarbin/vcs.git"
+description: """\
+
+[vcs] is a set of OCaml libraries for interacting with Git
+repositories. It provides a type-safe and direct-style API to
+programmatically perform Git operations, ranging from creating commits
+and branches to loading and navigating commit graphs in memory,
+computing diffs between revisions, and more.
+
+[Vcs_git_blocking] implements a Git provider for [vcs] based on the
+OCaml standard library. It runs the [git] CLI as a subprocess in a
+blocking fashion.
+
+"""
+tags: [ "git" "vcs" "blocking-io" ]
+x-maintenance-intent: [ "(latest)" ]

vcs-git-blocking.opam.template

@@ -0,0 +1,15 @@
+description: """\
+
+[vcs] is a set of OCaml libraries for interacting with Git
+repositories. It provides a type-safe and direct-style API to
+programmatically perform Git operations, ranging from creating commits
+and branches to loading and navigating commit graphs in memory,
+computing diffs between revisions, and more.
+
+[Vcs_git_blocking] implements a Git provider for [vcs] based on the
+OCaml standard library. It runs the [git] CLI as a subprocess in a
+blocking fashion.
+
+"""
+tags: [ "git" "vcs" "blocking-io" ]
+x-maintenance-intent: [ "(latest)" ]

vcs-git-eio.opam

@@ -37,3 +37,19 @@ build: [
   ]
 ]
 dev-repo: "git+https://github.com/mbarbin/vcs.git"
+description: """\
+
+[vcs] is a set of OCaml libraries for interacting with Git
+repositories. It provides a type-safe and direct-style API to
+programmatically perform Git operations, ranging from creating commits
+and branches to loading and navigating commit graphs in memory,
+computing diffs between revisions, and more.
+
+[Vcs_git_eio] implements a Git provider for [vcs] based on [eio]. It
+runs the [git] CLI as a subprocess in a non-blocking fashion.
+
+[eio]: https://github.com/ocaml-multicore/eio
+
+"""
+tags: [ "eio" "git" "vcs" "non-blocking-io" ]
+x-maintenance-intent: [ "(latest)" ]

vcs-git-eio.opam.template

@@ -0,0 +1,16 @@
+description: """\
+
+[vcs] is a set of OCaml libraries for interacting with Git
+repositories. It provides a type-safe and direct-style API to
+programmatically perform Git operations, ranging from creating commits
+and branches to loading and navigating commit graphs in memory,
+computing diffs between revisions, and more.
+
+[Vcs_git_eio] implements a Git provider for [vcs] based on [eio]. It
+runs the [git] CLI as a subprocess in a non-blocking fashion.
+
+[eio]: https://github.com/ocaml-multicore/eio
+
+"""
+tags: [ "eio" "git" "vcs" "non-blocking-io" ]
+x-maintenance-intent: [ "(latest)" ]

vcs-git-provider.opam

@@ -35,3 +35,20 @@ build: [
   ]
 ]
 dev-repo: "git+https://github.com/mbarbin/vcs.git"
+description: """\
+
+[vcs] is a set of OCaml libraries for interacting with Git
+repositories. It provides a type-safe and direct-style API to
+programmatically perform Git operations, ranging from creating commits
+and branches to loading and navigating commit graphs in memory,
+computing diffs between revisions, and more.
+
+[Vcs_git_provider] is not meant to be used directly by a user. Rather
+it is a helper library for building Git providers for [vcs]. Given the
+ability to run a [git] process, this library knows which commands to
+run, how to parse their output, and how to interpret their exit codes
+to turn them into typed results.
+
+"""
+tags: [ "cli" "git" "vcs" ]
+x-maintenance-intent: [ "(latest)" ]

vcs-git-provider.opam.template

@@ -0,0 +1,17 @@
+description: """\
+
+[vcs] is a set of OCaml libraries for interacting with Git
+repositories. It provides a type-safe and direct-style API to
+programmatically perform Git operations, ranging from creating commits
+and branches to loading and navigating commit graphs in memory,
+computing diffs between revisions, and more.
+
+[Vcs_git_provider] is not meant to be used directly by a user. Rather
+it is a helper library for building Git providers for [vcs]. Given the
+ability to run a [git] process, this library knows which commands to
+run, how to parse their output, and how to interpret their exit codes
+to turn them into typed results.
+
+"""
+tags: [ "cli" "git" "vcs" ]
+x-maintenance-intent: [ "(latest)" ]

vcs-test-helpers.opam

@@ -40,3 +40,19 @@ build: [
   ]
 ]
 dev-repo: "git+https://github.com/mbarbin/vcs.git"
+description: """\
+
+[vcs] is a set of OCaml libraries for interacting with Git
+repositories. It provides a type-safe and direct-style API to
+programmatically perform Git operations, ranging from creating commits
+and branches to loading and navigating commit graphs in memory,
+computing diffs between revisions, and more.
+
+[Vcs_test_helpers] is a library aimed at making it easier to write
+tests for libraries using [vcs] as a dependency. For example, it
+contains helpers for setting the running user's Git config, creating
+temporary repositories, and more.
+
+"""
+tags: [ "git" "tests" "vcs" ]
+x-maintenance-intent: [ "(latest)" ]

vcs-test-helpers.opam.template

@@ -0,0 +1,16 @@
+description: """\
+
+[vcs] is a set of OCaml libraries for interacting with Git
+repositories. It provides a type-safe and direct-style API to
+programmatically perform Git operations, ranging from creating commits
+and branches to loading and navigating commit graphs in memory,
+computing diffs between revisions, and more.
+
+[Vcs_test_helpers] is a library aimed at making it easier to write
+tests for libraries using [vcs] as a dependency. For example, it
+contains helpers for setting the running user's Git config, creating
+temporary repositories, and more.
+
+"""
+tags: [ "git" "tests" "vcs" ]
+x-maintenance-intent: [ "(latest)" ]

vcs.opam

@@ -34,3 +34,17 @@ build: [
   ]
 ]
 dev-repo: "git+https://github.com/mbarbin/vcs.git"
+description: """\
+
+[vcs] is a set of OCaml libraries for interacting with Git
+repositories. It provides a type-safe and direct-style API to
+programmatically perform Git operations, ranging from creating
+commits and branches to loading and navigating commit graphs in
+memory, computing diffs between revisions, and more.
+
+[Vcs] is the user-facing OCaml module for the project and
+dynamically dispatches its implementation at runtime.
+
+"""
+tags: [ "git" "vcs" ]
+x-maintenance-intent: [ "(latest)" ]

vcs.opam.template

@@ -0,0 +1,14 @@
+description: """\
+
+[vcs] is a set of OCaml libraries for interacting with Git
+repositories. It provides a type-safe and direct-style API to
+programmatically perform Git operations, ranging from creating
+commits and branches to loading and navigating commit graphs in
+memory, computing diffs between revisions, and more.
+
+[Vcs] is the user-facing OCaml module for the project and
+dynamically dispatches its implementation at runtime.
+
+"""
+tags: [ "git" "vcs" ]
+x-maintenance-intent: [ "(latest)" ]