Skip to content

Commit ca92907

Browse files
authored
Create windows.md
1 parent a1a925f commit ca92907

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

resources/windows.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Windows Help & Notes
2+
3+
## CRLF Warning
4+
5+
This is GitBash telling you that git is helping. Windows uses two characters for a new line `CR` (cariage return) and `LF` (line feed).
6+
Classic Mac Operating system used the `CR` character. Unix-like systems (including MacOS X) use only the `LF` character.
7+
If you try to open a file on Windows that has only `LF` characters, Windows will think it's all one line. To help you,
8+
since git knows people collaborate across file systems, when you check out files from the git database (`.git/` directory)
9+
git replaces `LF` characters with `CRLF` before updating your working directory.
10+
11+
When working on Windows, when you make a file locally, each new line will have `CRLF` in it. If your collaborator
12+
(or server, eg GitHub) runs not a unix or linux based operating system (it almost certainly does) these extra
13+
characters will make a mess and make the system interpret your code wrong. To help you out,
14+
git will automatically, for Windows users, convert `CRLF` to `LF` when it adds
15+
your work to the index (staging area). Then when you push, it's the compatible version.
16+
17+
[git documentation of the feature](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#Formatting-and-Whitespace)
18+

0 commit comments

Comments
 (0)