Skip to content

Commit

Permalink
Update references to the new gh location and add Acknowledgements
Browse files Browse the repository at this point in the history
  • Loading branch information
andersfugmann committed Feb 13, 2024
1 parent 6e92aab commit 6f48886
Show file tree
Hide file tree
Showing 8 changed files with 50 additions and 35 deletions.
1 change: 0 additions & 1 deletion CODEOWNERS

This file was deleted.

23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Ocaml protoc plugin
[![Main workflow](https://github.com/issuu/ocaml-protoc-plugin/actions/workflows/workflow.yml/badge.svg)](https://github.com/issuu/ocaml-protoc-plugin/actions/workflows/workflow.yml)
[![Main workflow](https://github.com/andersfugmann/ocaml-protoc-plugin/actions/workflows/workflow.yml/badge.svg)](https://github.com/andersfugmann/ocaml-protoc-plugin/actions/workflows/workflow.yml)

The goal of Ocaml protoc plugin is to create an up to date plugin for
the google protobuf compiler (`protoc`) to generate Ocaml types and
Expand Down Expand Up @@ -290,9 +290,9 @@ The distributed google types are compiled using default parameters,
i.e. without any ppx annotations.

If you want to change this, or add type annotations, you can copy the
[dune](https://github.com/issuu/ocaml-protoc-plugin/tree/master/src/google_types/dune)
[dune](https://github.com/andersfugmann/ocaml-protoc-plugin/tree/main/src/google_types/dune)
from the distribution to your own project, and make alterations
there. See the [echo\_deriving](https://github.com/issuu/ocaml-protoc-plugin/tree/master/examples/echo_deriving)
there. See the [echo\_deriving](https://github.com/andersfugmann/ocaml-protoc-plugin/tree/main/examples/echo_deriving)
example on how to do this.

# Example
Expand Down Expand Up @@ -381,4 +381,19 @@ let read_person binary_message =
```

More examples can be found under
[examples](https://github.com/issuu/ocaml-protoc-plugin/tree/master/examples)
[examples](https://github.com/andersfugmann/ocaml-protoc-plugin/tree/main/examples)

# Acknowledgements
Thanks to [Issuu](https://issuu.com) who has initially developed this library/plugin

Thanks to all contributers:
Anders Fugmann <[email protected]>
Andreas Dahl <[email protected]>
Dario Teixeira <[email protected]>
Kate <[email protected]>
Martin Slota <[email protected]>
Nymphium <[email protected]>
Rauan Mayemir <[email protected]>
Tim McGilchrist <[email protected]>
Virgile Prevosto <[email protected]>
Wojtek Czekalski <[email protected]>
2 changes: 1 addition & 1 deletion conf-protoc.opam
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
opam-version: "2.0"
maintainer: "Issuu"
maintainer: "Anders Fugmann"
authors: "Google"
license: "BSD-3-Clause"
homepage: "https://developers.google.com/protocol-buffers/"
Expand Down
11 changes: 6 additions & 5 deletions ocaml-protoc-plugin.opam
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
opam-version: "2.0"
maintainer: "Issuu"
maintainer: "Anders Fugmann"
authors: "Anders Fugmann <[email protected]>"
license: "APACHE-2.0"
homepage: "https://github.com/issuu/ocaml-protoc-plugin"
dev-repo: "git+https://github.com/issuu/ocaml-protoc-plugin"
bug-reports: "https://github.com/issuu/ocaml-protoc-plugin/issues"
doc: "https://issuu.github.io/ocaml-protoc-plugin/"
homepage: "https://github.com/andersfugmann/ocaml-protoc-plugin"
dev-repo: "git+https://github.com/andersfugmann/ocaml-protoc-plugin"
bug-reports: "https://github.com/andersfugmann/ocaml-protoc-plugin/issues"
doc: "https://andersfugmann.github.io/ocaml-protoc-plugin/"
build: [
["dune" "subst"] {dev}
["dune" "build" "-p" name "-j" jobs]
Expand All @@ -20,6 +20,7 @@ depends: [
"ppx_inline_test" {with-test}
"ppx_deriving" {with-test}
"bisect_ppx" {with-test}
"odoc" {with-doc}
"conf-pkg-config" {build}
]

Expand Down
12 changes: 6 additions & 6 deletions src/plugin/emit.ml
Original file line number Diff line number Diff line change
Expand Up @@ -281,12 +281,12 @@ let rec wrap_packages ~params ~syntax ~options scope message_type services = fun
signature, implementation

let emit_header implementation ~name ~syntax ~params =
Code.emit implementation `None "(************************************************)";
Code.emit implementation `None "(* AUTOGENERATED FILE - DO NOT EDIT! *)";
Code.emit implementation `None "(************************************************)";
Code.emit implementation `None "(* Generated by: ocaml-protoc-plugin *)";
Code.emit implementation `None "(* https://github.com/issuu/ocaml-protoc-plugin *)";
Code.emit implementation `None "(************************************************)";
Code.emit implementation `None "(********************************************************)";
Code.emit implementation `None "(* AUTOGENERATED FILE - DO NOT EDIT! *)";
Code.emit implementation `None "(********************************************************)";
Code.emit implementation `None "(* Generated by: ocaml-protoc-plugin *)";
Code.emit implementation `None "(* https://github.com/andersfugmann/ocaml-protoc-plugin *)";
Code.emit implementation `None "(********************************************************)";
Code.emit implementation `None "(*";
Code.emit implementation `None " Source: %s" name;
Code.emit implementation `None " Syntax: %s" (match syntax with `Proto2 -> "proto2" | `Proto3 -> "proto3");
Expand Down
12 changes: 6 additions & 6 deletions src/spec/descriptor.ml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
(************************************************)
(* AUTOGENERATED FILE - DO NOT EDIT! *)
(************************************************)
(* Generated by: ocaml-protoc-plugin *)
(* https://github.com/issuu/ocaml-protoc-plugin *)
(************************************************)
(********************************************************)
(* AUTOGENERATED FILE - DO NOT EDIT! *)
(********************************************************)
(* Generated by: ocaml-protoc-plugin *)
(* https://github.com/andersfugmann/ocaml-protoc-plugin *)
(********************************************************)
(*
Source: google/protobuf/descriptor.proto
Syntax: proto2
Expand Down
12 changes: 6 additions & 6 deletions src/spec/options.ml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
(************************************************)
(* AUTOGENERATED FILE - DO NOT EDIT! *)
(************************************************)
(* Generated by: ocaml-protoc-plugin *)
(* https://github.com/issuu/ocaml-protoc-plugin *)
(************************************************)
(********************************************************)
(* AUTOGENERATED FILE - DO NOT EDIT! *)
(********************************************************)
(* Generated by: ocaml-protoc-plugin *)
(* https://github.com/andersfugmann/ocaml-protoc-plugin *)
(********************************************************)
(*
Source: options.proto
Syntax: proto3
Expand Down
12 changes: 6 additions & 6 deletions src/spec/plugin.ml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
(************************************************)
(* AUTOGENERATED FILE - DO NOT EDIT! *)
(************************************************)
(* Generated by: ocaml-protoc-plugin *)
(* https://github.com/issuu/ocaml-protoc-plugin *)
(************************************************)
(********************************************************)
(* AUTOGENERATED FILE - DO NOT EDIT! *)
(********************************************************)
(* Generated by: ocaml-protoc-plugin *)
(* https://github.com/andersfugmann/ocaml-protoc-plugin *)
(********************************************************)
(*
Source: google/protobuf/compiler/plugin.proto
Syntax: proto2
Expand Down

0 comments on commit 6f48886

Please sign in to comment.