libfossil
libfossil.h
Go to the documentation of this file.
1/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2/* vim: set ts=2 et sw=2 tw=80: */
3#if !defined(ORG_FOSSIL_SCM_LIBFOSSIL_H_INCLUDED)
4#define ORG_FOSSIL_SCM_LIBFOSSIL_H_INCLUDED
5/*
6 Copyright 2013-2024 The Libfossil Authors, see LICENSES/BSD-2-Clause.txt
7
8 SPDX-License-Identifier: BSD-2-Clause-FreeBSD
9 SPDX-FileCopyrightText: 2021 The Libfossil Authors
10 SPDX-FileType: Code
11
12 Heavily indebted to the Fossil SCM project (https://fossil-scm.org).
13*/
14/** @file libfossil.h
15
16 This file is the primary header for the public APIs. It includes
17 various other header files. They are split into multiple headers
18 primarily because my lower-end systems choke on syntax-highlighting
19 them and browsing their (large) Doxygen output.
20
21 The "amalgamation" distribution of this library compounds all of
22 these headers into a single libfossil.h, and that is the way it is
23 intended to be used by clients which reside outside of this
24 project's own source tree.
25*/
26
27//#define FSL_OMIT_DEPRECATED
28
29/*
30 config.h MUST be included first so we can set some
31 portability flags and config-dependent typedefs!
32*/
33#include "fossil-scm/config.h"
34#include "fossil-scm/util.h"
35#include "fossil-scm/core.h"
36#include "fossil-scm/db.h"
37#include "fossil-scm/repo.h"
38#include "fossil-scm/checkout.h"
39#include "fossil-scm/confdb.h"
40#include "fossil-scm/hash.h"
41#include "fossil-scm/auth.h"
42#include "fossil-scm/vpath.h"
43#include "fossil-scm/sync.h"
44#include "fossil-scm/cli.h"
46
47#endif
48/* ORG_FOSSIL_SCM_LIBFOSSIL_H_INCLUDED */
fossil-checkout.h declares APIs specifically dealing with checkout-side state, as opposed to purely r...
fossil-confdb.h declares APIs dealing with fossil's various configuration option storage backends.
This file declares the core SCM-related public APIs.
This file holds APIs which are deprecated or otherwise "on the chopping block.
repo.h declares APIs specifically dealing with repository-db-side state, as opposed to specifically c...
sync.h declares APIs dealing with fossil repository synchronization.
This file declares a number of utility classes and routines used by libfossil.