fx_devguide - fx - The Developer's Guide
Welcome to fx, an application and set of packages providing extended management commands for the fossil SCM.
Please read the document fx - Introduction to fx, if you have not done so already, to get an overview of the whole system.
This document is a guide for developers working on fx, i.e. maintainers fixing bugs, extending the functionality of application or packages, etc.
Please read
first, if that was not done already.
Here we assume that the sources are already available in a directory of your choice, and that you not only know how to build and install them, but also have all the necessary requisites to actually do so. The guide to the sources in particular also explains which source code management system is used, where to find it, how to set it up, etc.
This directory contains the documentation sources. The texts are written in doctools format, whereas the figures are a mixture of TeX (math formulas), and tklib's dia(gram) package and application.
This directory contains the documentation converted to regular manpages (nroff) and HTML. It is called embedded because these files, while derived, are part of the fossil repository, i.e. embedded into it. This enables fossil to access and display these files when serving the repositories' web interface. The "Command Reference" link at https://core.tcl.tk/akupries/fx is, for example, accessing the generated HTML.
See the second image in section Architecture, and the associated explanations.
This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such at the fx Tracker. Please also report any ideas for enhancements you may have for either package and/or documentation.
Fossil support