File 0004-Use-rebar3_ex_doc.patch of Package telemetry

From ebe0f736b75ffa49caa610b4cc3d76bdb7afc005 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jos=C3=A9=20Valim?= <jose.valim@dashbit.co>
Date: Tue, 1 Feb 2022 16:43:41 +0100
Subject: [PATCH] Use rebar3_ex_doc

---
 RELEASE.md        |  6 ++----
 docs.config       |  4 ----
 docs.sh           | 15 ---------------
 rebar.config      |  8 ++++++++
 src/telemetry.erl |  2 +-
 5 files changed, 11 insertions(+), 24 deletions(-)
 delete mode 100644 docs.config
 delete mode 100755 docs.sh

diff --git a/RELEASE.md b/RELEASE.md
index 2318daf..c1edfba 100644
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -1,7 +1,5 @@
 # Steps for publishing new version
 
 1. Update version in `src/telemetry.app.src`
-2. Update version in `docs.sh`
-3. Run `./docs.sh`
-4. Run `rebar3 as docs hex publish`
-5. Run `rebar3 as docs hex docs`
+2. Run `rebar3 hex publish`
+3. Run `rebar3 hex publish docs` (requires https://hexdocs.pm/rebar3_ex_doc)
diff --git a/docs.config b/docs.config
deleted file mode 100644
index b3b819b..0000000
--- a/docs.config
+++ /dev/null
@@ -1,4 +0,0 @@
-{source_url, <<"https://github.com/beam-telemetry/telemetry">>}.
-{extras, [<<"CHANGELOG.md">>, <<"LICENSE">>, <<"NOTICE">>]}.
-{main, <<"telemetry">>}.
-{proglang, erlang}.
diff --git a/docs.sh b/docs.sh
deleted file mode 100755
index 061331e..0000000
--- a/docs.sh
+++ /dev/null
@@ -1,15 +0,0 @@
-#!/bin/bash
-set -e
-
-# Setup:
-#
-#     mix escript.install github elixir-lang/ex_doc
-#     asdf install erlang 24.0.2
-#     asdf local erlang 24.0.2
-
-rebar3 compile
-rebar3 as docs edoc
-version=1.0.0
-ex_doc "telemetry" $version "_build/default/lib/telemetry/ebin" \
-  --source-ref v${version} \
-  --config docs.config $@
diff --git a/rebar.config b/rebar.config
index 999230f..76d99ff 100644
--- a/rebar.config
+++ b/rebar.config
@@ -24,4 +24,12 @@
 {xref_checks,[undefined_function_calls, undefined_functions, locals_not_used,
               deprecated_function_calls, deprecated_functions]}.
 
+{hex, [
+    {doc, #{provider => ex_doc}}
+]}.
 
+{ex_doc, [
+    {source_url, <<"https://github.com/beam-telemetry/telemetry">>},
+    {extras, [<<"README.md">>, <<"CHANGELOG.md">>, <<"LICENSE">>, <<"NOTICE">>]},
+    {main, <<"readme">>}
+]}.
diff --git a/src/telemetry.erl b/src/telemetry.erl
index 5162d95..869481b 100644
--- a/src/telemetry.erl
+++ b/src/telemetry.erl
@@ -394,7 +394,7 @@ assert_event_name(Term) ->
 merge_ctx(#{telemetry_span_context := _} = Metadata, _Ctx) -> Metadata;
 merge_ctx(Metadata, Ctx) -> Metadata#{telemetry_span_context => Ctx}.
 
-%% @hidden
+%% @private
 report_cb(#{handler_id := Id}) ->
     {"The function passed as a handler with ID ~w is a local function.\n"
      "This means that it is either an anonymous function or a capture of a function "
-- 
2.35.3