From bd528215561bb1bf02c53d3064d8bcacc351434f Mon Sep 17 00:00:00 2001
From: Rudi Grinberg <rudi.grinberg@gmail.com>
Date: Tue, 10 Apr 2018 22:10:54 +0700
Subject: [PATCH] Mark internal (unstable) libraries as such

Add an internal description in the synopsis and also a comment in the ocamldoc
---
 src/ocaml-config/jbuild           | 2 +-
 src/ocaml-config/ocaml_config.mli | 4 +++-
 src/stdune/caml/caml.ml           | 2 ++
 src/stdune/caml/jbuild            | 2 +-
 src/stdune/jbuild                 | 2 +-
 src/usexp/jbuild                  | 1 +
 src/usexp/usexp.mli               | 4 +++-
 7 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/src/ocaml-config/jbuild b/src/ocaml-config/jbuild
index af200578a97..3fa057e438e 100644
--- 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
index 793377e5746..fbdbb92b853 100644
--- 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
index 82dc6ca93b3..a43c1037e09 100644
--- 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
index b8cfb6d73e4..04b16834208 100644
--- 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
index d6a2a3ca427..b1f82de0332 100644
--- 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
index 89e3240c571..53b46ee96e5 100644
--- 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
index 5fa3a2428ca..27e03dc740d 100644
--- 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]