Skip to content
This repository has been archived by the owner on Jan 27, 2022. It is now read-only.

Tweak topkg post. #5

Closed
wants to merge 1 commit into from
Closed

Tweak topkg post. #5

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
19 changes: 9 additions & 10 deletions _posts/2017-02-23-topkg.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags: platform mirage topkg
There is one issue that bazaars, library operating systems
like MirageOS or random left-padists face: how to scale extreme
software modularization. Scaling not from a software composition perspective;
this should be readily solved by using the type system and the
this could be readily solved by using the type system and the
functional programming techniques everyone's heard about. But scaling from a
purely bureaucratic point of view.

Expand All @@ -22,7 +22,7 @@ eco-system and that it follows its evolution. The bureaucracy of being
able to quickly push fixes and let dependents test them as if they
were released. The bureaucracy of making flawless releases: publishing
correct and reproducible tarballs, publishing documentation and submitting
the software package to the OCaml OPAM repository.
the software package to the OCaml opam repository.

All this has clearly nothing to do with the fun of programming and
calls for efficient, standardized, "don't make me think" procedures and
Expand All @@ -32,8 +32,8 @@ administrative task on each of these respectively represent one and three
hours gone -- dreadful hours. Any non-project specific bit that has to be
committed to these repositories is maintenance burden and a curse.

This is where [`topkg`](http://erratique.ch/software/topkg) fits in. There is no
point in repeating here what is written in the [documentation
This is where [topkg](http://erratique.ch/software/topkg) fits in.
If you want to learn more about it, make sure to read the [documentation
basics](http://erratique.ch/software/topkg/doc/Topkg.html#basics) and
the tool manual (`opam install topkg-care && topkg help`). To sum up,
you give `topkg` enough information so that it is able to determine what
Expand All @@ -42,7 +42,7 @@ needs to be installed in the current build environment. From these bits
try to *generate* one -- and produce a manifest file to let the package
manager install your package.

A few additional conventions and metadata bits you specify allows to
A few additional conventions and metadata bits you specify allow to
lint the package for good practices and release your software with the
`topkg` tool according to a well defined script. Read all the details
in `topkg help release` but the gist of it is:
Expand All @@ -59,15 +59,14 @@ topkg opam pkg # Create an opam package
topkg opam submit # Submit it to OCaml's opam repository

The last four steps can be performed via a single invocation to
topkg-bistro(1).
topkg bistro.
```

`topkg` is far from being a perfect system, it tries to compose with
the existing build infrastructure. It is a step towards what is needed
from a packaging workflow perspective to scale modularity: the act of
releasing should be an inane, swift, robust and painless process.

If you are interested in *programming* and sharing your results, give `topkg`
a try. No left-pad function left behind.

(1) [`topkg-bistro`](https://github.com/dbuenzli/topkg/blob/master/src-bin/bistro.mli)
If you are interested in *programming* and sharing your results, give
[topkg](http://erratique.ch/software/topkg) a try. No left-pad function
left behind.