Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

brotli.1.2.0 - via opam-publish #7599

Merged
merged 1 commit into from
Oct 10, 2016
Merged

brotli.1.2.0 - via opam-publish #7599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/brotli/brotli.1.2.0/descr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Bindings to Google's Brotli compresion algorithm

OCaml Bindings to brotli, Google's compression algorithm for the web
Source: https://github.com/google/brotli/ RFC:
http://www.ietf.org/id/draft-alakuijala-brotli
38 changes: 38 additions & 0 deletions packages/brotli/brotli.1.2.0/opam
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
opam-version: "1.2"
maintainer: "Edgar Aroutiounian <[email protected]>"
authors: "Edgar Aroutiounian <[email protected]>"
homepage: "http://hyegar.com"
bug-reports: "https://github.com/fxfactorial/ocaml-brotli/issues"
license: "BSD-3-clause"
tags: ["clib:stdc" "clib:brotli"]
dev-repo: "https://github.com/fxfactorial/ocaml-brotli.git"
build: [
["oasis" "setup" "-setup-update" "dynamic"]
["ocaml" "setup.ml" "-configure" "--prefix" prefix]
["ocaml" "setup.ml" "-build"]
]
install: ["ocaml" "setup.ml" "-install"]
build-test: [
["ocaml" "setup.ml" "-configure" "--enable-tests"]
["ocaml" "setup.ml" "-build"]
["ocaml" "setup.ml" "-test"]
]
build-doc: ["ocaml" "setup.ml" "-doc"]
remove: ["ocamlfind" "remove" "brotli"]
depends: [
"oasis" {build}
"ocamlfind" {build}
"ocamlbuild" {build}
]
depexts: [
[["debian"] ["clang" "libc++-dev"]]
[["ubuntu"] ["clang" "libc++-dev"]]
]
available: [ocaml-version >= "4.03.0"]
messages: [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this message needed ? I think depexts are automatically advertised and suggested to be run in case of build failure.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apparently it doesn't matter in this case anyway, so I'll lessen it

"Note, you'll need to have libbrotli installed: https://github.com/bagder/libbrotli"
]
post-messages: [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that post-messages is a suitable place for sample code. Sample code should go in the doc: directory of the package.

Copy link
Contributor Author

@fxfactorial fxfactorial Oct 9, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I respectfully disagree, its nice to have some quick high level idea of how to use a library, I think I've seen some npm packages do this as well (Merlin provides a similiar thing in its post-message install)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its nice to have some quick high level idea of how to use a library

I'm not saying you should not provide sample code. I'm saying that this is not the place to provide it. Here are a few reasons:

  1. What do I do if want to go back to that sample code later, reinstall the package ?
  2. This gets output on each install of the package, the user may not care about this because e.g. it is pulled through a dependency or because he already knows how to use the package. In this case this is only polluting OPAM's output with irrelevant noise.
  3. The best of way of providing this to the end-user in the library's API documentation, that's the natural place a programmer will look for it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay you're right, I concede.

"Make sure you had libbrotli installed, get it at:https://github.com/bagder/libbrotli" {failure & (os = "osx")}
"Make sure you have clang++ available" {failure & (os != "osx")}
]
2 changes: 2 additions & 0 deletions packages/brotli/brotli.1.2.0/url
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
http: "https://github.com/fxfactorial/ocaml-brotli/archive/v1.2.0.tar.gz"
checksum: "b73b45dc41a4e8fa793a6f1069022e27"