Skip to content

Commit a3364aa

Browse files
pks-tpks-t
committed
Move libgit.a sources into separate "lib/" directory
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 <[email protected]>
1 parent 624ec1c commit a3364aa

693 files changed

Lines changed: 800 additions & 799 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitmodules‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
[submodule "sha1collisiondetection"]
2-
path = sha1collisiondetection
2+
path = lib/sha1collisiondetection
33
url = https://github.com/cr-marcstevens/sha1collisiondetection.git
44
branch = master

‎Documentation/Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -505,10 +505,10 @@ lint-docs-man-section-order: $(LINT_DOCS_MAN_SECTION_ORDER)
505505
.PHONY: lint-docs-fsck-msgids
506506
LINT_DOCS_FSCK_MSGIDS = .build/lint-docs/fsck-msgids.ok
507507
$(LINT_DOCS_FSCK_MSGIDS): lint-fsck-msgids.perl
508-
$(LINT_DOCS_FSCK_MSGIDS): ../fsck.h fsck-msgids.adoc
508+
$(LINT_DOCS_FSCK_MSGIDS): ../lib/fsck.h fsck-msgids.adoc
509509
$(call mkdir_p_parent_template)
510510
$(QUIET_GEN)$(PERL_PATH) lint-fsck-msgids.perl \
511-
../fsck.h fsck-msgids.adoc $@
511+
../lib/fsck.h fsck-msgids.adoc $@
512512
lint-docs-fsck-msgids: $(LINT_DOCS_FSCK_MSGIDS)
513513

514514
## Lint: delimited sections

0 commit comments

Comments
 (0)