Mark internal (unstable) libraries as such

Add an internal description in the synopsis and also a comment in the ocamldoc
ocaml · Apr 10, 2018 · bd52821 · bd52821
1 parent 1488359
commit bd52821
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 5 deletions.
diff --git a/src/ocaml-config/jbuild b/src/ocaml-config/jbuild
@@ -4,4 +4,4 @@
  ((name      ocaml_config)
   (public_name jbuilder.ocaml_config)
   (libraries (stdune usexp))
-  (synopsis  "Interpret the output of 'ocamlc -config'")))
+  (synopsis  "[Internal] Interpret the output of 'ocamlc -config'")))
diff --git a/src/ocaml-config/ocaml_config.mli b/src/ocaml-config/ocaml_config.mli
@@ -1,4 +1,6 @@
-(** Represent the output of [ocamlc -config] *)
+(** Represent the output of [ocamlc -config].
+
+    This library is internal to jbuilder and guarantees no API stability. *)
 
 open Stdune
 

diff --git a/src/stdune/caml/caml.ml b/src/stdune/caml/caml.ml
@@ -1,3 +1,5 @@
+(** This library is internal to jbuilder and guarantees no API stability. *)
+
 module Filename = Filename
 module String   = String
 module Char     = Char

diff --git a/src/stdune/caml/jbuild b/src/stdune/caml/jbuild
@@ -1,4 +1,4 @@
 (library
  ((name caml)
   (public_name jbuilder.caml)
-  (synopsis "Wrapped version of the OCaml stdlib")))
+  (synopsis "[Internal] Wrapped version of the OCaml stdlib")))
diff --git a/src/stdune/jbuild b/src/stdune/jbuild
@@ -1,5 +1,5 @@
 (library
  ((name stdune)
   (public_name jbuilder.stdune)
-  (synopsis "Standard library of Dune")
+  (synopsis "[Internal] Standard library of Dune")
   (libraries (caml unix))))
diff --git a/src/usexp/jbuild b/src/usexp/jbuild
@@ -2,6 +2,7 @@
 
 (library
  ((name usexp)
+  (synopsis "[Internal] S-expression library")
   (public_name jbuilder.usexp)))
 
 (rule

diff --git a/src/usexp/usexp.mli b/src/usexp/usexp.mli
@@ -1,4 +1,6 @@
-(** Parsing of s-expressions *)
+(** Parsing of s-expressions.
+
+    This library is internal to jbuilder and guarantees no API stability.*)
 
 module Atom : sig
   type t = private A of string [@@unboxed]