mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 21:51: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>
62 lines
1.8 KiB
C
62 lines
1.8 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_ITERATOR_H
|
|
#define REFTABLE_ITERATOR_H
|
|
|
|
#include "reftable-system.h"
|
|
#include "reftable-record.h"
|
|
|
|
struct reftable_iterator_vtable;
|
|
|
|
/* iterator is the generic interface for walking over data stored in a
|
|
* reftable.
|
|
*/
|
|
struct reftable_iterator {
|
|
struct reftable_iterator_vtable *ops;
|
|
void *iter_arg;
|
|
};
|
|
|
|
/*
|
|
* Position the iterator at the ref record with given name such that the next
|
|
* call to `next_ref()` would yield the record.
|
|
*/
|
|
int reftable_iterator_seek_ref(struct reftable_iterator *it,
|
|
const char *name);
|
|
|
|
/* reads the next reftable_ref_record. Returns < 0 for error, 0 for OK and > 0:
|
|
* end of iteration.
|
|
*/
|
|
int reftable_iterator_next_ref(struct reftable_iterator *it,
|
|
struct reftable_ref_record *ref);
|
|
|
|
/*
|
|
* Position the iterator at the log record with given name and update index
|
|
* such that the next call to `next_log()` would yield the record.
|
|
*/
|
|
int reftable_iterator_seek_log_at(struct reftable_iterator *it,
|
|
const char *name, uint64_t update_index);
|
|
|
|
/*
|
|
* Position the iterator at the newest log record with given name such that the
|
|
* next call to `next_log()` would yield the record.
|
|
*/
|
|
int reftable_iterator_seek_log(struct reftable_iterator *it,
|
|
const char *name);
|
|
|
|
/* reads the next reftable_log_record. Returns < 0 for error, 0 for OK and > 0:
|
|
* end of iteration.
|
|
*/
|
|
int reftable_iterator_next_log(struct reftable_iterator *it,
|
|
struct reftable_log_record *log);
|
|
|
|
/* releases resources associated with an iterator. */
|
|
void reftable_iterator_destroy(struct reftable_iterator *it);
|
|
|
|
#endif
|