**License:** same as Fossil: the "2-Clause BSD" a.k.a. "FreeBSD License".

# Update Feb. 2021: Back from the Dead

After a 6-year forced hiatus due to chronic RSI, libfossil is again making some headway. In early Feb. 2021 its hashing support was brought up to date with regard to fossil's hardened SHA1 and SHA3-256 hashes. That was the major technical hurdle preventing further progress, so now they way is clear (or clearer) for bringing the library into the 2020's.

A chat room and forum have been established for this effort but they are limited to developers. Please [get in touch][home-sgb] if you are a participant and need info about either. This project is *currently* only opened to active participants of the [Fossil SCM][home-fossil] project (as committers and/or forum participants). That said, it does not require the same code release waiver which that project requires. If/when the project reaches a client-usable state, it will be opened up for wider participation.
A chat room and forum have been established for this effort but they are currently limited to developers. Please [get in touch][home-sgb] if you are a participant and need info about either. This project is *currently* only opened to active participants of the [Fossil SCM][home-fossil] project (as committers and/or forum participants). That said, it does not require the same code release waiver which that project requires. If/when the project reaches a client-usable state, it will be opened up for wider participation.


[home-sgb]: https://wanderinghorse.net/home/stephan/
[home-fossil]: https://fossil-scm.org
[f-apps]: /doc/ckout/f-apps/

## Status, [](TODOs), and Whatnot

All of this code is an <em>experiment</em>, and it does not represent a commitment by anyone. It is alpha quality. What's there works but is subject to change and there is still a great deal of the higher-level SCM bits left to port in and refactor to make them usable via library-style interfaces. Anyone looking for a project roadmap/timeline is asked respectfully to look elsewhere - there is no timebox on nor schedule for this project/experiment. That said: the [f-apps][] demonstrate what functionality is working.

The code changes can be followed via [the timeline](/timeline).

The current public (and documented) API can be found in [the header files](/dir?name=include/fossil-scm), and occasionally that gets [exported to doxygen][doxygen-docs].


# "Rules" for Code Contributors

   *  When working on bits which themselves write to the repository, e.g. creating checkins, please be *exceedingly careful* not to corrupt the db :-D. The library has several layers of defense against the injection of problematic control artifacts, but still... be careful.
   *  Please try to conform to the rough overall coding style (as initially laid out by Fossil v1). We're not picky about whether or not spaces belong before/after an `if`, but the general overall style should be *more or less* uniform.
   *  Please build with the highest possible warning level and enable fatal warnings (in GCC and similar compilers: `-Wall -Werror`).
   *  The trunk currently has no stability guarantees and is very much in flux, so feel free to work there instead of a branch if you like.
   *  Please build with the highest possible warning level and enable fatal warnings (in GCC and similar compilers: `-Wall -Werror -pedantic`).
   *  The trunk currently has no stability guarantees and is very much in flux, so feel free to work there instead of a branch if you like. Insofar as possible/reasonable, using libfossil's own [f-apps][] for working with the repository is recommended (e.g. using `f-checkin` to perform checkins).

There is nothing holy or sacred about this repo, so feel free to hack at will. Most of the library's sanity tests are packaged in <tt>[f-sanity.c](/finfo?name=f-apps/f-sanity.c)</tt>. See <tt>[fossil-cli.h](/finfo?name=include/fossil-scm/fossil-cli.h)</tt> for a mini-framework to bootstrap new apps and [f-apps][].


<h2>News</h2>

Notable changes (newest at the top)...