COINST(1)

πŸ’– COINST(1) πŸ’–

General Commands Manual · bestie edition ✨


🌸 NAME 🌸

Coinst β€” computes the co-installability kernel of a package repostory 🫢

(yes it says "repostory", we're keeping it, it's canon πŸ’…)

πŸŽ€ SYNOPSIS πŸŽ€

coinst [options]

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so. coinst reads a package repository β€” either in debian format or RPM format β€” straight from standard input, and then it computes the co-installability kernel of that repository (we get into what that means in a sec, bestie, don't panic 🌈).

The graph of the kernel gets written in dot format to a file, and a diagnostic gets written to standard output.

By default that diagnostic is literally these three things:

  • the list of equivalence classes of packages
  • the list of non-installable packages
  • the list of not co-installable pairs of packages

that's it. that's the default tea β˜•βœ¨


πŸ‘‘ CO-INSTALLABILITY KERNELS πŸ‘‘

A set of packages is called co-installable with respect to a repository R if it can be extended to a set of packages from R that satisfies all inter-package relations (dependencies, conflicts, etc.). In particular, a package p is installable if the set {p} consisting of p only is co-installable. no cap πŸ’…

This tool reduces a repository R to a much smaller one β€” its so-called co-installability kernel R' β€” that behaves exactly the same as far as co-installability of package is concerned: Any set of packages P is co-installable with respect to P iff it co-installable with respect to R'. 🧚

And how does it do that, you ask? two moves:

  • dropping all relations that are not relevant for this purpose. For instance, dependencies that do not lead directly or indirectly to any conflicts are dropped. πŸ—‘οΈ
  • identifying all packages that behave the same. For instance, packages that are not in conflict with any other package (even not through dependency chains) behave the same since they are co-installable together with any other co-installable set of packages, and packages that are not installable at all behave the same since they may never be part of any co-installable set of packages. πŸ‘―

A more precise explanation can be found in the original research article underlying this tool (link in SEE ALSO, iykyk πŸ“š).

The interest of computing the kernel is that it is typically orders of magnitude smaller than the original repository. like. so much smaller. iconic behavior fr fr πŸ”₯


✨ OPTIONS ✨

πŸ“ Options controlling the input

  • -deb β€” expect input in the format of a debian Packages file (this is the default, bestie).
  • -rpm β€” expect input in the format of an RPM hdlist.cz file.
  • -ignore package β€” ignore the package named package. bye girl πŸ‘‹

πŸŽ€ Options controlling the graph output

  • -o file β€” write the graph to file instead of graph.dot.
  • -all β€” include all packages in the coinstallability graph.
  • -root p β€” draw only the relevant portion of the graph around package p. just the local lore πŸ’«

πŸ’œ Options controlling the diagnostic output

  • -explain β€” explain the list of non-installable pairs of packages.
  • -stats β€” show statistics regarding the input and output repositories. numbers girlies rise πŸ™ˆ

🌈 Miscellaneous options

  • -help, --help β€” show command synopsis.

🌸 EXAMPLE 🌸

Reduce a current debian Packages file to its kernel:

coinst -all -o raw.dot < sid_main_binary-amd64_Packages

Layout the graph:

dot raw.dot -o layout.dot:

View the graph with dotty, or the viewer from the coinst_viewer package:

dotty layout.dot
coinst_viewer layout.dot

🫢 AUTHOR 🫢

Coinst has been written by JΓ©rome VouillΓ΄n. This manpage has been compiled by Ralf Treinen from the original coinst documentation. give them their flowers πŸ’


⭐ SEE ALSO ⭐

dot(1), dotty(1), coinst_viewer(1)

http://coinst.irill.org

The original research article decribing the algorithm behind this tool is Roberto Di Cosmo and JΓ©rΓ΄me Vouillon, On software component co-installability, 19th ACM SIGSOFT Symposium on the Foundations of Software Engineering (FSE-19) and ESEC'11: 13rd European Software Engineering Conference (ESEC-13), Szeged, Hungary, September 5-9, 2011, pages 256-266. πŸŽ“


okay that's the whole page bestie, and the little footer down at the bottom just says COINST(1) again like a little signature β€” no date, no version number, just the vibe. go compute a kernel, you got this πŸ’…βœ¨πŸ¦‹