Skip to content

Commit

Permalink
Change all links to the wiki
Browse files Browse the repository at this point in the history
Since we just merged the wiki into the main repository (to stave off
future vandalism), let's change the links in this here repository so
they point at the new location.

This trick was performed by:

  # Construct `sed` instructions for replacing the basenames of the wiki
  # links with URL-encoded versions that also add the Markdown file
  # extension `.md`, being careful only to replace the actual Markdown
  # _links_ (i.e. the basename must be preceded either by a slash or by
  # an opening parenthesis, and followed by a closing parenthesis).
  extra="$(git -C Documentation/git-for-windows/ ls-files |
    sed -n '/\.md$/{
      h
      s|'\''|%27|g
      s|(|%28|g
      s|)|%29|g
      s|`|%60|g
      x
      s|\.md$||
      s|'\''|&\\&&|g
      s|\.|\\&|g
      G
      s|^|-e '\''s@\\([/(]\\)|
      s|\n|\\()\\)@\\1|
      s|$|\\2@g'\''|
      p
    }' |
    tr '\n' ' '
  )"
  # Edit all files containing links to the Git for Windows wiki
  for f in $(git grep -l git-for-windows/git/wiki)
  do
    eval sed -i "$extra" \
      -e \''s|\(git-for-windows/git/\)wiki/|\1blob/HEAD/Documentation/git-for-windows/|g'\' \
      -e \''s|\(git-for-windows/git/\)wiki|\1tree/HEAD/Documentation/git-for-windows|g'\' \
      \'"$f"\'
  done

It will need to be repeated in the `build-extra` and
`git-for-windows.github.io` repositories.

Signed-off-by: Johannes Schindelin <[email protected]>
  • Loading branch information
dscho committed May 12, 2024
1 parent b78c1dc commit 45b6596
Show file tree
Hide file tree
Showing 25 changed files with 89 additions and 89 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ When running `make`, you can use `-j$(nproc)` to automatically use the number of
on your machine as the number of concurrent build processes.

You can go deeper on the Windows-specific build process by reading the
[technical overview](https://github.com/git-for-windows/git/wiki/Technical-overview) or the
[guide to compiling Git with Visual Studio](https://github.com/git-for-windows/git/wiki/Compiling-Git-with-Visual-Studio).
[technical overview](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Technical-overview.md) or the
[guide to compiling Git with Visual Studio](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Compiling-Git-with-Visual-Studio.md).

## Building `git` on Windows with Visual Studio

Expand Down Expand Up @@ -120,7 +120,7 @@ you want to extend the functional tests to be sure no one breaks your feature in
### Functional Tests

Navigate to the `t/` directory and type `make` to run all tests or use `prove` as
[described in the Git for Windows wiki](https://github.com/git-for-windows/git/wiki/Building-Git):
[described in the Git for Windows wiki](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Building-Git.md):

```
prove -j12 --state=failed,save ./t[0-9]*.sh
Expand Down
94 changes: 47 additions & 47 deletions Documentation/git-for-windows/0.-Index.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
This is for the poor souls in corporate IE environments who can't expand the page list.

* [Home](https://github.com/git-for-windows/git/wiki)
* [32 bit issues](https://github.com/git-for-windows/git/wiki/32-bit-issues)
* [Adding regression tests](https://github.com/git-for-windows/git/wiki/Adding-regression-tests)
* [Auto launching ssh agent when git starts](https://github.com/git-for-windows/git/wiki/Auto-launching-ssh-agent-when-git-starts)
* [Building Git](https://github.com/git-for-windows/git/wiki/Building-Git)
* [Building msys2 runtime](https://github.com/git-for-windows/git/wiki/Building-msys2-runtime)
* [Building new package versions](https://github.com/git-for-windows/git/wiki/Building-new-package-versions)
* [Compiling Git with Visual Studio](https://github.com/git-for-windows/git/wiki/Compiling-Git-with-Visual-Studio)
* [Contact](https://github.com/git-for-windows/git/wiki/Contact)
* [Continuous Integration (CI)](https://github.com/git-for-windows/git/wiki/Continuous-Integration-(CI))
* [Debugging Git](https://github.com/git-for-windows/git/wiki/Debugging-Git)
* [Diagnosing performance issues](https://github.com/git-for-windows/git/wiki/Diagnosing-performance-issues)
* [exec() semantics](https://github.com/git-for-windows/git/wiki/exec()-semantics)
* [FAQ](https://github.com/git-for-windows/git/wiki/FAQ)
* [File names, Branch names, Path quotation, Executable bit and file modes, core.FileMode](https://github.com/git-for-windows/git/wiki/File-names,-Branch-names,-Path-quotation,-Executable-bit-and-file-modes,-core.FileMode)
* [Git cannot create a file or directory with a long path](https://github.com/git-for-windows/git/wiki/Git-cannot-create-a-file-or-directory-with-a-long-path)
* [Git-for-Windows' "snapshots"](https://github.com/git-for-windows/git/wiki/Snapshot-builds)
* [Good commits](https://github.com/git-for-windows/git/wiki/Good-commits)
* [How to participate](https://github.com/git-for-windows/git/wiki/How-to-participate)
* [Install inside MSYS2 proper](https://github.com/git-for-windows/git/wiki/Install-inside-MSYS2-proper)
* [Install or update inside MSYS2, Cygwin or Git-for-windows itself](https://github.com/git-for-windows/git/wiki/Install-or-update-inside-MSYS2,-Cygwin-or-Git-for-windows-itself)
* [Issue reporting guidelines](https://github.com/git-for-windows/git/wiki/Issue-reporting-guidelines)
* [Making a portable Git](https://github.com/git-for-windows/git/wiki/Making-a-portable-Git)
* [Making an installer](https://github.com/git-for-windows/git/wiki/Making-an-installer)
* [Mapping between Git Installer GUI Settings And Command Line Arguments](https://github.com/git-for-windows/git/wiki/Mapping-between-Git-Installer-GUI-Settings-And-Command-Line-Arguments)
* [Merge Conflicts Resolving and Remembering them](https://github.com/git-for-windows/git/wiki/Merge-Conflicts---Resolving-and-Remembering-them)
* [MinGit is Git for Windows Applications](https://github.com/git-for-windows/git/wiki/MinGit)
* [MSYS2 Notes](https://github.com/git-for-windows/git/wiki/MSYS2-Notes)
* [OpenSSH Integration with Pageant](https://github.com/git-for-windows/git/wiki/OpenSSH-Integration-with-Pageant)
* [Package management](https://github.com/git-for-windows/git/wiki/Package-management)
* [Performance profiling with Visual Studio](https://github.com/git-for-windows/git/wiki/Performance-profiling-with-Visual-Studio)
* [Rebasing Git for Windows](https://github.com/git-for-windows/git/wiki/Rebasing-Git-for-Windows)
* [Release Hashes](https://github.com/git-for-windows/git/wiki/Release-Hashes)
* [Running Git's regression tests](https://github.com/git-for-windows/git/wiki/Running-Git's-regression-tests)
* [Setting your Core.Editor ( e.g. Notepad )](https://github.com/git-for-windows/git/wiki/Setting-your-Core.Editor-(-e.g.-Notepad-))
* [Silent or Unattended Installation](https://github.com/git-for-windows/git/wiki/Silent-or-Unattended-Installation)
* [Sourcetrail code viewer and linkage to Visual Studio, for Git](https://github.com/git-for-windows/git/wiki/Sourcetrail-code-viewer-and-linkage-to-Visual-Studio,-for-Git)
* [Symbolic Links](https://github.com/git-for-windows/git/wiki/Symbolic-Links)
* [Technical overview](https://github.com/git-for-windows/git/wiki/Technical-overview)
* [The "Git-wrapper"](https://github.com/git-for-windows/git/wiki/Git-wrapper)
* [The difference between MINGW and MSYS2](https://github.com/git-for-windows/git/wiki/The-difference-between-MINGW-and-MSYS2)
* [Updating your SDK](https://github.com/git-for-windows/git/wiki/Updating-your-SDK)
* [Upgrading the 'perl' component to a new version](https://github.com/git-for-windows/git/wiki/Upgrading-the-%60perl%60-component-to-a-new-version)
* [Using sshd to host a git server](https://github.com/git-for-windows/git/wiki/Using-sshd-to-host-a-git-server)
* [Vagrant](https://github.com/git-for-windows/git/wiki/Vagrant)
* [Visual Studio and MSVC compilation](https://github.com/git-for-windows/git/wiki/Visual-Studio-and-MSVC-compilation)
* [Zip Archives extracting the released archives](https://github.com/git-for-windows/git/wiki/Zip-Archives---extracting-the-released-archives)
* [Home](https://github.com/git-for-windows/git/tree/HEAD/Documentation/git-for-windows)
* [32 bit issues](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/32-bit-issues.md)
* [Adding regression tests](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Adding-regression-tests.md)
* [Auto launching ssh agent when git starts](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Auto-launching-ssh-agent-when-git-starts.md)
* [Building Git](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Building-Git.md)
* [Building msys2 runtime](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Building-msys2-runtime.md)
* [Building new package versions](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Building-new-package-versions.md)
* [Compiling Git with Visual Studio](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Compiling-Git-with-Visual-Studio.md)
* [Contact](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Contact.md)
* [Continuous Integration (CI)](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Continuous-Integration-%28CI%29.md)
* [Debugging Git](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Debugging-Git.md)
* [Diagnosing performance issues](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Diagnosing-performance-issues.md)
* [exec() semantics](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/exec()-semantics)
* [FAQ](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/FAQ.md)
* [File names, Branch names, Path quotation, Executable bit and file modes, core.FileMode](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/File-names,-Branch-names,-Path-quotation,-Executable-bit-and-file-modes,-core.FileMode.md)
* [Git cannot create a file or directory with a long path](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Git-cannot-create-a-file-or-directory-with-a-long-path.md)
* [Git-for-Windows' "snapshots"](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Snapshot-builds.md)
* [Good commits](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Good-commits.md)
* [How to participate](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/How-to-participate.md)
* [Install inside MSYS2 proper](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Install-inside-MSYS2-proper.md)
* [Install or update inside MSYS2, Cygwin or Git-for-windows itself](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Install-or-update-inside-MSYS2,-Cygwin-or-Git-for-windows-itself.md)
* [Issue reporting guidelines](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Issue-reporting-guidelines.md)
* [Making a portable Git](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Making-a-portable-Git.md)
* [Making an installer](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Making-an-installer.md)
* [Mapping between Git Installer GUI Settings And Command Line Arguments](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Mapping-between-Git-Installer-GUI-Settings-And-Command-Line-Arguments.md)
* [Merge Conflicts Resolving and Remembering them](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Merge-Conflicts---Resolving-and-Remembering-them.md)
* [MinGit is Git for Windows Applications](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/MinGit.md)
* [MSYS2 Notes](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/MSYS2-Notes.md)
* [OpenSSH Integration with Pageant](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/OpenSSH-Integration-with-Pageant.md)
* [Package management](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Package-management.md)
* [Performance profiling with Visual Studio](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Performance-profiling-with-Visual-Studio.md)
* [Rebasing Git for Windows](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Rebasing-Git-for-Windows.md)
* [Release Hashes](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Release-Hashes.md)
* [Running Git's regression tests](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Running-Git%27s-regression-tests.md)
* [Setting your Core.Editor ( e.g. Notepad )](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Setting-your-Core.Editor-(-e.g.-Notepad-))
* [Silent or Unattended Installation](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Silent-or-Unattended-Installation.md)
* [Sourcetrail code viewer and linkage to Visual Studio, for Git](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Sourcetrail-code-viewer-and-linkage-to-Visual-Studio,-for-Git.md)
* [Symbolic Links](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Symbolic-Links.md)
* [Technical overview](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Technical-overview.md)
* [The "Git-wrapper"](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Git-wrapper.md)
* [The difference between MINGW and MSYS2](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/The-difference-between-MINGW-and-MSYS2.md)
* [Updating your SDK](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Updating-your-SDK.md)
* [Upgrading the 'perl' component to a new version](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Upgrading-the-%60perl%60-component-to-a-new-version)
* [Using sshd to host a git server](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Using-sshd-to-host-a-git-server.md)
* [Vagrant](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Vagrant.md)
* [Visual Studio and MSVC compilation](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Visual-Studio-and-MSVC-compilation.md)
* [Zip Archives extracting the released archives](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Zip-Archives---extracting-the-released-archives.md)

-Fin-
4 changes: 2 additions & 2 deletions Documentation/git-for-windows/Building-Git.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Once the SDK built Git, it is *very* easy to build another revision of Git, such
1. if you want to test a Pull Request, call `git fetch origin refs/pull/<id>/head`, where `<id>` is the number of the Pull Request (e.g. if you want to test Pull Request #606, you would call `git fetch origin refs/pull/606/head`),
2. if you want to test a custom branch, call `git fetch <url> <branch>` instead, where `<url>` is the URL of the repository and `<branch>` is the name of the branch to test (e.g. if you wanted to test @dscho's `cool-new-feature` branch, you would call `git fetch https://github.com/dscho/git cool-new-feature`),
4. check out the revision that was just fetched: `git checkout FETCH_HEAD`,
5. continue as [above](https://github.com/git-for-windows/git/wiki/Building-Git#build-git) either by `make install` or `make test`.
5. continue as [above](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Building-Git#build-git) either by `make install` or `make test`.

# Updating to the newest Git for Windows version

Expand All @@ -48,7 +48,7 @@ cd /usr/src/git/t
## See also Regression Testing

Single tests, block of tests, or the whole test suite can be run, as detailed in
[Running Git's regression-tests](https://github.com/git-for-windows/git/wiki/Running-Git's-regression-tests)
[Running Git's regression-tests](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Running-Git%27s-regression-tests.md)


---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
As described in [Package management](Package-management), Git for Windows' SDK is a close derivative of the [MSYS2](https://msys2.github.io/) system, and as such, its components are built using `makepkg` and `makepkg-mingw` (borrowed from Arch Linux' [`pacman`](https://wiki.archlinux.org/index.php/Pacman)).
As described in [Package management](Package-management.md), Git for Windows' SDK is a close derivative of the [MSYS2](https://msys2.github.io/) system, and as such, its components are built using `makepkg` and `makepkg-mingw` (borrowed from Arch Linux' [`pacman`](https://wiki.archlinux.org/index.php/Pacman)).

Most of those packages are actually built by the MSYS2 project and consumed by Git for Windows. However, a couple of components (including cURL and OpenSSH) _are_ built by Git for Windows, e.g. to be able to react faster to newly-available versions, or to allow for modifications specific to Git for Windows.

Expand Down Expand Up @@ -37,4 +37,4 @@ The strategy that worked best for the Git for Windows maintainer goes like this:
9. test (`cd ../.. && sdk build`)
10. commit, push (and open a PR unless pushing directly to `main`)

Caveat: this strategy needs manual adjustments if the archive in question contains files with DOS line endings (I am looking at you, [Perl](https://github.com/git-for-windows/git/wiki/Upgrading-the-%60perl%60-component-to-a-new-version) _shakes fist_): `import-tars.perl` will happily import those verbatim, but the `bsdtar` used by `makepkg` to unpack the archive will convert them to Unix line endings, and if the patches expect DOS line endings, they won't apply.
Caveat: this strategy needs manual adjustments if the archive in question contains files with DOS line endings (I am looking at you, [Perl](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Upgrading-the-%60perl%60-component-to-a-new-version) _shakes fist_): `import-tars.perl` will happily import those verbatim, but the `bsdtar` used by `makepkg` to unpack the archive will convert them to Unix line endings, and if the patches expect DOS line endings, they won't apply.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Please note: this page describes how to compile Git's source code in Visual Stud
> [!WARNING]
> The `vs/main` branch and `git.sln` is deprecated. The current approach is to open the `git` folder in VS directly, refer to the [README of the `vs/main` branch](https://github.com/git-for-windows/git/tree/vs/main).
Git's source code (and hence also Git for Windows' source code) is [usually built using GNU C and GNU Make in a Git for Windows SDK](https://github.com/git-for-windows/git/wiki/Building-Git).
Git's source code (and hence also Git for Windows' source code) is [usually built using GNU C and GNU Make in a Git for Windows SDK](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Building-Git.md).

However, as of Git for Windows v2.11.0, a much more convenient way is available: by cloning https://github.com/git-for-windows/git and checking out the `vs/main` branch, you will automatically have project definitions ready to go with Visual Studio.

Expand Down Expand Up @@ -40,4 +40,4 @@ prove --timer --jobs 15 ./t[0-9]*.sh

# Browsing the code

You can also use the Sourcetrail code browser (now open source) in conjunction with Visual Studio, see [Sourcetrail code viewer](https://github.com/git-for-windows/git/wiki/Sourcetrail-code-viewer-and-linkage-to-Visual-Studio,-for-Git) page.
You can also use the Sourcetrail code browser (now open source) in conjunction with Visual Studio, see [Sourcetrail code viewer](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Sourcetrail-code-viewer-and-linkage-to-Visual-Studio,-for-Git.md) page.
2 changes: 1 addition & 1 deletion Documentation/git-for-windows/Contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Please state the nature of your medical emergency.

# I found a bug!

Please follow [our guide lines](https://github.com/git-for-windows/git/wiki/Issue-reporting-guidelines) on reporting bugs.
Please follow [our guide lines](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Issue-reporting-guidelines.md) on reporting bugs.

# I have a question!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ If the problem lies with a specific Git command, the most straight-forward way t

The canonical profiling tool in GCC's tool set is [`gprof`](https://sourceware.org/binutils/docs/gprof/). However, the MINGW version of the GCC tools offered by MSYS2 has been known to produce empty output on occasion.

An more convenient alternative is to use [Visual Studio's Performance Profiler](https://github.com/git-for-windows/git/wiki/Performance-profiling-with-Visual-Studio) (which is available in the free-of-cost Community version) which offers a powerful graphical user interface.
An more convenient alternative is to use [Visual Studio's Performance Profiler](https://github.com/git-for-windows/git/blob/HEAD/Documentation/git-for-windows/Performance-profiling-with-Visual-Studio.md) (which is available in the free-of-cost Community version) which offers a powerful graphical user interface.

# Trace executions in the Bash startup

Expand Down
Loading

0 comments on commit 45b6596

Please sign in to comment.