BRANCHES.md: Add explanation of branches and using forks

.clang-format

@@ -6,6 +6,8 @@
 
 # Use tabs whenever we need to fill whitespace that spans at least from one tab
 # stop to the next one.
+#
+# These settings are mirrored in .editorconfig.  Keep them in sync.
 UseTab: Always
 TabWidth: 8
 IndentWidth: 8

.editorconfig

@@ -0,0 +1,16 @@
+[*]
+charset = utf-8
+insert_final_newline = true
+
+# The settings for C (*.c and *.h) files are mirrored in .clang-format.  Keep
+# them in sync.
+[*.{c,h,sh,perl,pl,pm}]
+indent_style = tab
+tab_width = 8
+
+[*.py]
+indent_style = space
+indent_size = 4
+
+[COMMIT_EDITMSG]
+max_line_length = 72

.gitattributes

@@ -4,9 +4,14 @@
 *.perl eol=lf diff=perl
 *.pl eof=lf diff=perl
 *.pm eol=lf diff=perl
+*.png binary
 *.py eol=lf diff=python
 *.bat eol=crlf
-/Documentation/git-*.txt eol=lf
+/Documentation/**/*.txt eol=lf
 /command-list.txt eol=lf
 /GIT-VERSION-GEN eol=lf
 /mergetools/* eol=lf
+/Documentation/git-merge.txt conflict-marker-size=32
+/Documentation/gitk.txt conflict-marker-size=32
+/Documentation/user-manual.txt conflict-marker-size=32
+/t/t????-*.sh conflict-marker-size=32

.gitignore

@@ -1,3 +1,6 @@
+/fuzz_corpora
+/fuzz-pack-headers
+/fuzz-pack-idx
 /GIT-BUILD-OPTIONS
 /GIT-CFLAGS
 /GIT-LDFLAGS
@@ -78,6 +81,9 @@
 /git-init-db
 /git-interpret-trailers
 /git-instaweb
+/git-legacy-rebase
+/git-legacy-rebase--interactive
+/git-legacy-stash
 /git-log
 /git-ls-files
 /git-ls-remote
@@ -99,8 +105,9 @@
 /git-mergetool--lib
 /git-mktag
 /git-mktree
-/git-name-rev
+/git-multi-pack-index
 /git-mv
+/git-name-rev
 /git-notes
 /git-p4
 /git-pack-redundant
@@ -113,12 +120,14 @@
 /git-pull
 /git-push
 /git-quiltimport
+/git-range-diff
 /git-read-tree
 /git-rebase
 /git-rebase--am
-/git-rebase--helper
+/git-rebase--common
 /git-rebase--interactive
 /git-rebase--merge
+/git-rebase--preserve-merges
 /git-receive-pack
 /git-reflog
 /git-remote
@@ -242,6 +251,7 @@
 /config.mak.autogen
 /config.mak.append
 /configure
+/.vscode/
 /tags
 /TAGS
 /cscope*
@@ -266,6 +276,3 @@ Release/
 /UpgradeLog*.htm
 /git.VC.VC.opendb
 /git.VC.db
-/.vagrant/
-/vagrant2[0-9][0-9][0-9]*-*-*
-/d2[0-9][0-9][0-9]*-*-*

.mailmap

@@ -21,25 +21,30 @@ Anders Kaseorg <[email protected]> <[email protected]>
 Aneesh Kumar K.V <[email protected]>
 Amos Waterland <[email protected]> <[email protected]>
 Amos Waterland <[email protected]> <[email protected]>
+Ben Peart <[email protected]> <[email protected]>
+Ben Peart <[email protected]> <[email protected]>
 Ben Walton <[email protected]> <[email protected]>
 Benoit Sigoure <[email protected]> <[email protected]>
 Bernt Hansen <[email protected]> <[email protected]>
 Brandon Casey <[email protected]> <[email protected]>
-brian m. carlson <[email protected]> Brian M. Carlson <[email protected]>
+brian m. carlson <[email protected]>
 brian m. carlson <[email protected]> <[email protected]>
 Bryan Larsen <[email protected]> <[email protected]>
 Bryan Larsen <[email protected]> <[email protected]>
 Cheng Renquan <[email protected]>
 Chris Shoemaker <[email protected]>
 Chris Wright <[email protected]> <[email protected]>
+Christian Ludwig <[email protected]> <[email protected]>
 Cord Seele <[email protected]> <[email protected]>
 Christian Couder <[email protected]> <[email protected]>
 Christian Stimming <[email protected]> <[email protected]>
+Christopher Díaz Riveros <[email protected]> Christopher Diaz Riveros
 Csaba Henk <[email protected]> <[email protected]>
 Dan Johnson <[email protected]>
 Dana L. How <[email protected]> <[email protected]>
 Dana L. How <[email protected]> Dana How
 Daniel Barkalow <[email protected]>
+Daniel Knittl-Frank <[email protected]> knittl
 Daniel Trstenjak <[email protected]> <[email protected]>
 Daniel Trstenjak <[email protected]> <[email protected]>
 David Brown <[email protected]> <[email protected]>
@@ -49,6 +54,7 @@ David Reiss <[email protected]> <dreiss@dreiss-vmware.(none)>
 David S. Miller <[email protected]>
 David Turner <[email protected]> <[email protected]>
 David Turner <[email protected]> <[email protected]>
+Derrick Stolee <[email protected]> <[email protected]>
 Deskin Miller <[email protected]>
 Dirk Süsserott <[email protected]>
 Eric Blake <[email protected]> <[email protected]>
@@ -57,6 +63,7 @@ Eric S. Raymond <[email protected]>
 Eric Wong <[email protected]> <[email protected]>
 Erik Faye-Lund <[email protected]> <[email protected]>
 Eyvind Bernhardsen <[email protected]> <[email protected]>
+Fangyi Zhou <[email protected]> Zhou Fangyi
 Florian Achleitner <[email protected]> <[email protected]>
 Franck Bui-Huu <[email protected]> <[email protected]>
 Frank Lichtenheld <[email protected]> <[email protected]>
@@ -86,13 +93,16 @@ Jason McMullan <[email protected]>
 Jason Riedy <[email protected]> <[email protected]>
 Jason Riedy <[email protected]> <[email protected]>
 Jay Soffian <[email protected]> <[email protected]>
+Jean-Noël Avila <[email protected]> Jean-Noel Avila
+Jean-Noël Avila <[email protected]> Jean-Noël AVILA
 Jeff King <[email protected]> <[email protected]>
 Jeff Muizelaar <[email protected]> <[email protected]>
 Jens Axboe <[email protected]> <[email protected]>
 Jens Axboe <[email protected]> <[email protected]>
 Jens Lindström <[email protected]> Jens Lindstrom <[email protected]>
 Jim Meyering <[email protected]> <[email protected]>
 Joachim Berdal Haga <[email protected]>
+Joachim Jablon <[email protected]> <[email protected]>
 Johannes Schindelin <[email protected]> <[email protected]>
 Johannes Sixt <[email protected]> <[email protected]>
 Johannes Sixt <[email protected]> <[email protected]>
@@ -145,12 +155,15 @@ Mark Levedahl <[email protected]> <[email protected]>
 Mark Rada <[email protected]>
 Martin Langhoff <[email protected]> <[email protected]>
 Martin von Zweigbergk <[email protected]> <[email protected]>
+Masaya Suzuki <[email protected]> <[email protected]>
 Matt Draisey <[email protected]> <[email protected]>
 Matt Kraai <[email protected]> <[email protected]>
 Matt McCutchen <[email protected]> <[email protected]>
 Matthias Kestenholz <[email protected]> <[email protected]>
+Matthias Rüster <[email protected]> Matthias Ruester
 Matthias Urlichs <[email protected]> <smurf@kiste.(none)>
 Matthias Urlichs <[email protected]> <[email protected]>
+Matthieu Moy <[email protected]> <[email protected]>
 Michael Coleman <[email protected]>
 Michael J Gruber <[email protected]> <[email protected]>
 Michael J Gruber <[email protected]> <[email protected]>
@@ -174,7 +187,11 @@ Nick Stokoe <[email protected]> Nick Woolley <[email protected]>
 Nick Stokoe <[email protected]> Nick Woolley <[email protected]>
 Nicolas Morey-Chaisemartin <[email protected]> <[email protected]>
 Nicolas Morey-Chaisemartin <[email protected]> <[email protected]>
+Nicolas Morey-Chaisemartin <[email protected]> <[email protected]>
+Nicolas Morey-Chaisemartin <[email protected]> <[email protected]>
+Nicolas Morey-Chaisemartin <[email protected]> <[email protected]>
 Nicolas Sebrecht <[email protected]> <[email protected]>
+Orgad Shaneh <[email protected]> <[email protected]>
 Paolo Bonzini <[email protected]> <[email protected]>
 Pascal Obry <[email protected]> <[email protected]>
 Pascal Obry <[email protected]> <[email protected]>
@@ -194,6 +211,7 @@ Philipp A. Hartmann <[email protected]> <[email protected]>
 Philippe Bruhat <[email protected]>
 Ralf Thielow <[email protected]> <[email protected]>
 Ramsay Jones <[email protected]> <[email protected]>
+Randall S. Becker <[email protected]> <[email protected]>
 René Scharfe <[email protected]> <[email protected]>
 René Scharfe <[email protected]> Rene Scharfe
 Richard Hansen <[email protected]> <[email protected]>
@@ -213,6 +231,8 @@ Sean Estabrooks <[email protected]>
 Sebastian Schuberth <[email protected]> <[email protected]>
 Seth Falcon <[email protected]> <[email protected]>
 Shawn O. Pearce <[email protected]>
+Wei Shuyu <[email protected]> Shuyu Wei
+Sidhant Sharma <[email protected]> Sidhant Sharma [:tk]
 Simon Hausmann <[email protected]> <[email protected]>
 Simon Hausmann <[email protected]> <[email protected]>
 Stefan Beller <[email protected]> <[email protected]>
@@ -230,6 +250,7 @@ Steven Walter <[email protected]> <[email protected]>
 Sven Verdoolaege <[email protected]> <[email protected]>
 Sven Verdoolaege <[email protected]> <[email protected]>
 SZEDER Gábor <[email protected]> <[email protected]>
+Tao Qingyun <[email protected]> <[email protected]>
 Tay Ray Chuan <[email protected]>
 Ted Percival <[email protected]> <[email protected]>
 Theodore Ts'o <[email protected]>
@@ -253,7 +274,8 @@ Uwe Kleine-König <[email protected]> <[email protected]
 Uwe Kleine-König <[email protected]> <[email protected]>
 Uwe Kleine-König <[email protected]> <[email protected]>
 Ville Skyttä <[email protected]> <[email protected]>
-Vitaly "_Vi" Shukela <[email protected]>
+Vitaly "_Vi" Shukela <[email protected]> <[email protected]>
+Vitaly "_Vi" Shukela <[email protected]> Vitaly _Vi Shukela
 W. Trevor King <[email protected]> <[email protected]>
 William Pursell <[email protected]>
 YONETANI Tomokazu <[email protected]> <[email protected]>

.travis.yml

@@ -1,7 +1,5 @@
 language: c
 
-sudo: false
-
 cache:
   directories:
     - $HOME/travis-cache
@@ -14,19 +12,9 @@ compiler:
   - clang
   - gcc
 
-addons:
-  apt:
-    sources:
-    - ubuntu-toolchain-r-test
-    packages:
-    - language-pack-is
-    - git-svn
-    - apache2
-    - gcc-8
-
 matrix:
   include:
-    - env: jobname=GETTEXT_POISON
+    - env: jobname=GIT_TEST_GETTEXT_POISON
       os: linux
       compiler:
       addons:
@@ -52,22 +40,11 @@ matrix:
     - env: jobname=StaticAnalysis
       os: linux
       compiler:
-      addons:
-        apt:
-          packages:
-          - coccinelle
-      before_install:
       script: ci/run-static-analysis.sh
       after_failure:
     - env: jobname=Documentation
       os: linux
       compiler:
-      addons:
-        apt:
-          packages:
-          - asciidoc
-          - xmlto
-      before_install:
       script: ci/test-documentation.sh
       after_failure:
 

BRANCHES.md

@@ -0,0 +1,51 @@
+Branches used in this repo
+==========================
+
+The document explains the branching structure that we are using in the git for VFSForGit repository as well as the forking strategy that we have adopted for contributing.
+
+Repo Branches
+-------------
+
+1. master
+
+    This will track the git for windows repository master branch
+
+2. vfs
+
+    Would like to use this branch as an ever-green branch that continually rebases the VFSForGit changes onto a windows ever-green branch that is on the core/master, so that we can detect when the patches for VFSForGit have issues or if we have a new version patches sent upstream git we can regenerate this branch.
+
+3. vs/master
+
+    This tracks with the git for windows repository vs/master branch and are the generated files for using a Visual Studio solution.
+
+4. vfs-#
+
+    These branches are used to track the specific version that match git for windows with the VFSForGit specific patches on top.  When a new version of git for windows is released, the VFSForGit patches will be rebased on that windows version and a new gvfs-# branch created to create pull requests against.
+
+    #### Examples
+    ```
+    vfs-2.20.0
+    vfs-2.20.1
+    ```
+
+    The versions of git for VFSForGit are based on the git for windows versions.  v2.20.0.vfs.1 will correspond with the v2.20.0.windows.1 with the VFSForGit specific patches applied to the windows version. 
+
+Tags
+----
+
+We are using annotated tags to build the version number for git.  The build will look back through the commit history to find the first tag matching `v[0-9]*vfs*` and build the git version number using that tag.
+
+Forking
+-------
+
+A personal fork of this repository and a branch in that repository should be used for development.
+
+These branches should be based on the latest vfs-# branch.  If there are work in progress pull requests that you have based on a previous version branch when a new version branch is created, you will need to move your patches to the new branch to get them in that latest version.
+
+#### Example
+```
+git clone <personal fork repo URL>
+git remote add ms https://github.com/Microsoft/git.git
+git checkout -b my-changes ms/vfs-2.20.0 --no-track
+git push -fu origin HEAD
+```

CONTRIBUTING.md

@@ -418,3 +418,10 @@ potentially interested reviewers.
 ```
 git send-email [email protected] --cc=<email1> --cc=<email2> [dir with patches]/*.patch
 ```
+
+To submit a nth version patch (say version 3):
+
+```
+git send-email [email protected] --cc=<email1> --cc=<email2> \
+    --in-reply-to=<the message id of cover letter of patch v2> [dir with patches]/*.patch
+```

Documentation/.gitignore

@@ -12,3 +12,4 @@ cmds-*.txt
 mergetools-*.txt
 manpage-base-url.xsl
 SubmittingPatches.txt
+tmp-doc-diff/

Documentation/CodingGuidelines

@@ -118,6 +118,24 @@ For shell scripts specifically (not exhaustive):
 		do this
 	fi
 
+ - If a command sequence joined with && or || or | spans multiple
+   lines, put each command on a separate line and put && and || and |
+   operators at the end of each line, rather than the start. This
+   means you don't need to use \ to join lines, since the above
+   operators imply the sequence isn't finished.
+
+	(incorrect)
+	grep blob verify_pack_result \
+	| awk -f print_1.awk \
+	| sort >actual &&
+	...
+
+	(correct)
+	grep blob verify_pack_result |
+	awk -f print_1.awk |
+	sort >actual &&
+	...
+
  - We prefer "test" over "[ ... ]".
 
  - We do not write the noiseword "function" in front of shell
@@ -358,7 +376,10 @@ For C programs:
    string_list for sorted string lists, a hash map (mapping struct
    objects) named "struct decorate", amongst other things.
 
- - When you come up with an API, document it.
+ - When you come up with an API, document its functions and structures
+   in the header file that exposes the API to its callers. Use what is
+   in "strbuf.h" as a model for the appropriate tone and level of
+   detail.
 
  - The first #include in C files, except in platform specific compat/
    implementations, must be either "git-compat-util.h", "cache.h" or