mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 13:21:17 -05:00
9759608622
The Git project is not exactly the easiest project to get started in: it's written in C and POSIX shell, with bits of Perl, Rust and other languages sprinkled into it. On top of that, the project has grown somewhat organically over time, making the codebase hard to navigate. These are problems that we're aware of, and there have been and still are efforts to clean up some of the technical debt that is natural to exist an a project that is more than 20 years old. Furthermore, we provide resources to newcomers that help them out like our coding guidelines, code of conduct or "MyFirstContribution.adoc". But there is a rather practical problem: finding your way around in our project's tree is not easy. Doing a directory listing in the top-level directory will present you with more than 550 files, which makes it extremely hard for a newcomer to figure out what files they are even supposed to look at. This makes the onboarding experience somewhat harder than it really needs to be. This isn't only a problem for newcomers though, as I myself struggle to find the files I am looking for because of the sheer number of files. Besides the problem of discoverability it also creates a problem of structure. It is not obvious at all which files are part of "libgit.a" and which files are only linked into our final executables. So while we have this split in our build systems, that split is not evident at all in our tree. Introduce a new "lib/" directory and move all of our sources for "libgit.a" into it to fix these issues. It makes the split we have evident and reduces the number of files in our top-level tree from 550 files to ~80 files. This is still a lot of files, but it's significantly easier to navigate already. Furthermore, we can further iterate after this step and think about introducing a better structure for remaining files, as well. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
73 lines
1.9 KiB
C
73 lines
1.9 KiB
C
/*
|
|
* Copyright 2020 Google LLC
|
|
*
|
|
* Use of this source code is governed by a BSD-style
|
|
* license that can be found in the LICENSE file or at
|
|
* https://developers.google.com/open-source/licenses/bsd
|
|
*/
|
|
|
|
#ifndef REFTABLE_ERROR_H
|
|
#define REFTABLE_ERROR_H
|
|
|
|
#include "reftable-system.h"
|
|
|
|
/*
|
|
* Errors in reftable calls are signaled with negative integer return values. 0
|
|
* means success.
|
|
*/
|
|
enum reftable_error {
|
|
/* Unexpected file system behavior */
|
|
REFTABLE_IO_ERROR = -2,
|
|
|
|
/* Format inconsistency on reading data */
|
|
REFTABLE_FORMAT_ERROR = -3,
|
|
|
|
/* File does not exist. Returned from block_source_from_file(), because
|
|
* it needs special handling in stack.
|
|
*/
|
|
REFTABLE_NOT_EXIST_ERROR = -4,
|
|
|
|
/* Trying to access locked data. */
|
|
REFTABLE_LOCK_ERROR = -5,
|
|
|
|
/* Misuse of the API:
|
|
* - on writing a record with NULL refname.
|
|
* - on writing a record before setting the writer limits.
|
|
* - on writing a reftable_ref_record outside the table limits
|
|
* - on writing a ref or log record before the stack's
|
|
* next_update_inde*x
|
|
* - on writing a log record with multiline message with
|
|
* exact_log_message unset
|
|
* - on reading a reftable_ref_record from log iterator, or vice versa.
|
|
*
|
|
* When a call misuses the API, the internal state of the library is
|
|
* kept unchanged.
|
|
*/
|
|
REFTABLE_API_ERROR = -6,
|
|
|
|
/* Decompression error */
|
|
REFTABLE_ZLIB_ERROR = -7,
|
|
|
|
/* Wrote a table without blocks. */
|
|
REFTABLE_EMPTY_TABLE_ERROR = -8,
|
|
|
|
/* Invalid ref name. */
|
|
REFTABLE_REFNAME_ERROR = -10,
|
|
|
|
/* Entry does not fit. This can happen when writing outsize reflog
|
|
messages. */
|
|
REFTABLE_ENTRY_TOO_BIG_ERROR = -11,
|
|
|
|
/* Trying to write out-of-date data. */
|
|
REFTABLE_OUTDATED_ERROR = -12,
|
|
|
|
/* An allocation has failed due to an out-of-memory situation. */
|
|
REFTABLE_OUT_OF_MEMORY_ERROR = -13,
|
|
};
|
|
|
|
/* convert the numeric error code to a string. The string should not be
|
|
* deallocated. */
|
|
const char *reftable_error_str(int err);
|
|
|
|
#endif
|