ostree/apidoc
Colin Walters 8c1542134c lib/repo: Enable locking by default, but drop external API
The code has been sitting around for a while but since I disabled
it by default, I doubt anyone is really using it or relying on it.

This patch and turns on locking by default, and also drops the
API which was only public in the experimental API builds.
Conceptually these are two distinct things, and we
may actually want to split up the patches.

I don't think this will break anyone, but it's hard to say for sure.
It's also going to be hard to find out until we actually release
I suspect...

But anyone who is broken should be able to add `locking=false` into
their repo config.  On the flip side Endless has been shipping with
this enabled and it is reported to help.

The reason to drop the APIs: I'm a bit concerned about the interactions over time
between libostree's use of the API and any apps that start using it.
For example, if an app specifies a SHARED lock in their code, then
later internally we decide to temporarily grab an `EXCLUSIVE`, but the
app had a second thread/process that was `EXCLUSIVE` already, and
that process was waiting on the first bit of code, then we could
deadlock. I can't think of a real world situation where this would happen
yet though.

We are likely to in the future have say `fsck` take an external lock,
`checkout` grab a shared one, etc.

Closes: #1555
Approved by: jlebon
2018-04-30 17:24:51 +00:00
..
.gitignore docs: Get API docs working again 2016-06-09 18:15:49 +00:00
Makefile.am Add SPDX-License-Identifier to source files 2018-01-30 20:03:42 +00:00
ostree-docs.xml docs: Get API docs working again 2016-06-09 18:15:49 +00:00
ostree-experimental-sections.txt lib/repo: Enable locking by default, but drop external API 2018-04-30 17:24:51 +00:00
ostree-sections.txt lib/repo: Add ostree_repo_traverse_commit_union_with_parents 2018-04-14 15:36:21 +00:00