Skip to content

Commit aaf4dd6

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 aaf4dd6

694 files changed

Lines changed: 819 additions & 818 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.

‎.github/workflows/main.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ jobs:
179179
uses: actions/checkout@v5
180180
with:
181181
repository: 'microsoft/vcpkg'
182-
path: 'compat/vcbuild/vcpkg'
182+
path: 'lib/compat/vcbuild/vcpkg'
183183
- name: download vcpkg artifacts
184184
uses: git-for-windows/get-azure-pipelines-artifact@v0
185185
with:
@@ -189,19 +189,19 @@ jobs:
189189
uses: microsoft/setup-msbuild@v2
190190
- name: copy dlls to root
191191
shell: cmd
192-
run: compat\vcbuild\vcpkg_copy_dlls.bat release
192+
run: lib\compat\vcbuild\vcpkg_copy_dlls.bat release
193193
- name: generate Visual Studio solution
194194
shell: bash
195195
run: |
196-
cmake `pwd`/contrib/buildsystems/ -DCMAKE_PREFIX_PATH=`pwd`/compat/vcbuild/vcpkg/installed/x64-windows \
196+
cmake `pwd`/contrib/buildsystems/ -DCMAKE_PREFIX_PATH=`pwd`/lib/compat/vcbuild/vcpkg/installed/x64-windows \
197197
-DNO_GETTEXT=YesPlease -DPERL_TESTS=OFF -DPYTHON_TESTS=OFF -DCURL_NO_CURL_CMAKE=ON
198198
- name: MSBuild
199199
run: msbuild git.sln -property:Configuration=Release -property:Platform=x64 -maxCpuCount:4 -property:PlatformToolset=v142
200200
- name: bundle artifact tar
201201
shell: bash
202202
env:
203203
MSVC: 1
204-
VCPKG_ROOT: ${{github.workspace}}\compat\vcbuild\vcpkg
204+
VCPKG_ROOT: ${{github.workspace}}\lib\compat\vcbuild\vcpkg
205205
run: |
206206
mkdir -p artifacts &&
207207
eval "$(make -n artifacts-tar INCLUDE_DLLS_IN_ARTIFACTS=YesPlease ARTIFACTS_DIRECTORY=artifacts NO_GETTEXT=YesPlease 2>&1 | grep ^tar)"

‎.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)