<h1>Fossil Library API Scratchpad</h1>

See also: [download], [th1ish], [http://fossil.wanderinghorse.net/repos/f2/doxygen/|doxygen docs] (refreshed occasionally from current sources)


This source code repository houses experimentation for a potential library API for the [http://fossil-scm.org|Fossil SCM]. The primary goal is to port existing behaviour into a library form (the v1 app is extremely monolithic in nature). While it has been informally dubbed "v2", so far no format-breaking changes are planned so it might turn out to provide an alternative to fossil v1, as opposed to a replacement.


This code currently doesn't do much - it is intended for those interested in following or participating in the design of libfossil. All current Fossil committers (those who have a signed a license waiver on file with DRH) are welcomed contributors - email me your preferred user name to get access: sgbeal@googlemail.com.


<h2>Status, TODOs, and Whatnot</h2>

All of this code is an <em>experiment</em>, and it does not represent a commitment by anyone that any of this code wll some day end up living under the umbrella of the larger Fossil SCM project. If all goes well, that's the eventual goal, though. It is pre-alpha quality. What's there works but there is still a a great deal of the SCM-specific infrastructure left to port in and refactor to make it usable via library-style interfaces. Anyone looking for a timeline is asked respectfully to look elsewhere - there is no timebox on nor schedule for this project/experiment.
All of this code is an <em>experiment</em>, and it does not represent a commitment by anyone that any of this code wll some day end up living under the umbrella of the larger Fossil SCM project. If all goes well, that's the eventual goal, though. It is pre-alpha quality. What's there works but there is still a a great deal of the SCM-specific infrastructure left to port in and refactor to make it 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.

The current public (and documented) API can be found in [http://fossil.wanderinghorse.net/repos/f2/index.cgi/finfo?name=include/fossil/fossil.h|fossil.h]
The current public (and documented) API can be found in [http://fossil.wanderinghorse.net/repos/f2/index.cgi/finfo?name=include/fossil/fossil.h|fossil.h], and occasionally that gets [http://fossil.wanderinghorse.net/repos/f2/doxygen/|exported to doxygen].

TODOs... you might want to get a coffee/tee/beer before starting through [https://docs.google.com/document/d/12g0s5A2TPX7-y47Nsw235rvsjcuh49TnHfMDB4ASvlo/view|the list].
TODOs, design discussions, etc... you might want to get a coffee/tee/beer before starting through [https://docs.google.com/document/d/12g0s5A2TPX7-y47Nsw235rvsjcuh49TnHfMDB4ASvlo/view|the list].

A list of recent notable changes is maintained below.

An experimental [th1ish|script engine binding] is being created in parallel with the library.

<h2>"Rules" for Code Contributors</h2>