Skip to content

git-bash: document the Windows initiator program #2357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

git-bash: document the Windows initiator program #2357

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions Documentation/git-bash.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
git-bash(0)
==========

NAME
----
git-bash - A Windows initialiser for the bash window on that OS
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure that "initialiser" is a good term. Maybe git-bash - Starts an interactive Bash in a new terminal window instead?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure that "initialiser" is a good term.

The whole document was very much an initial (near empty) draft with content stolen from another page for simplicity, hence the remnants.

It's there to catch suggestions, rather than be even a good draft - there are still lots of bits that are behind that green curtain of ignorance..

Thanks for the comments and feedback.


SYNOPSIS
--------

git-bash [--cd-to-home] [--xx] []
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am fairly sure that --xx is not a valid option.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't sure what the valid options are...


DESCRIPTION
-----------

The `git-bash.exe` provides a windows run time executable that takes in a
few parameter and then starts (typically) the mintty terminal window
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's with the funny indentation?

with a modified path such that `git` is found on the search path [Windows or *nix?]
and the MSYS2 interface is used to convert path references from windows
style (c:\w\x\y) to unix style (/c/w/x/y)

etc. etc.

More description and explanation of how it all works and the necessary
levels of redirection and misdirection so that it all 'just works'
despite severe incompatibilities in operating philosphy..

include::glossary-content.txt[]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it would be a good idea to include the glossary here.


SEE ALSO
--------

C:\git-sdk-64\usr\src\MINGW-packages\mingw-w64-git\git-bash.rc
describe this (and the .rc extension) for basic windows users.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's not a "SEE ALSO". That would need to go into a chapter above, something like "Technical Details".


C:\git-sdk-64\usr\src\MINGW-packages\mingw-w64-git\compat-bash.rc
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That has nothing to do with git-bash.exe. Those are the resources to be used for <Git>\bin\bash.exe.



C:\git-sdk-64\usr\src\git\contrib\mw-to-git\bin-wrapper\
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MediaWiki to Git? What does that have to do with git-bash.exe?

various wrappers to describe.


https://github.com/git-for-windows/git/issues/1674
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That should not go into the text, but into the commit message.


There is almost no tutorial or documentation suggesting anyone how to create your own custom git-bash.exe arguments like "--cd-to-home" . Can you kindly provide the steps and guidance to do that ?

link:user-manual.html[The Git User's Manual]

GIT
---
Part of the linkgit:git[1] suite