Merge pull request #1912 from AdmiringWorm/git-description

(git) Move arguments to its own file

automatic/git.install/ARGUMENTS.md

@@ -0,0 +1,29 @@
+# Git Package Parameters
+
+The following package parameters are available to be used together with the `git` and `git.install` packages.
+**NOTE: Not all parameters may be available for all versions of these two packages**
+
+- `/GitOnlyOnPath` - Puts gitinstall\cmd on path. This is also done by default if no package parameters are set.
+- `/GitAndUnixToolsOnPath` - Puts gitinstall\bin on path. This setting will override `/GitOnlyOnPath`.
+- `/NoAutoCrlf` - Ensure _'Checkout as is, commit as is'_. This setting **only affects new installs**, it will not override an existing `.gitconfig`.
+- `/WindowsTerminal` - Makes `vim` use the regular Windows terminal instead of MinTTY terminal.
+- `/NoShellIntegration` - Disables open GUI and open shell integration ( _"Git GUI Here"_ and _"Git Bash Here"_ entries in context menus).
+- `/NoGuiHereIntegration` - Disables open GUI shell integration ( _"Git GUI Here"_ entry in context menus).
+- `/NoShellHereIntegration` - Disables open git bash shell integration ( _"Git Bash Here"_ entry in context menus).
+- `/NoCredentialManager` - Disable _Git Credential Manager_ by adding `$Env:GCM_VALIDATE='false'` user environment variable.
+- `/NoGitLfs` - Disable Git LFS installation.
+- `/SChannel` - Configure Git to use the Windows native SSL/TLS implementation (SChannel) instead of OpenSSL. This aligns Git HTTPS behavior with other Windows applications and system components and increases manageability in enterprise environments.
+- `/NoOpenSSH` - Git will not install its own OpenSSH (and related) binaries but use them as found on the PATH.
+- `/WindowsTerminalProfile` - Add a Git Bash Profile to Windows Terminal.
+- `/Symlinks` - Enable symbolic links (requires the SeCreateSymbolicLink permission). Existing repositories are unaffected by this setting.
+- `/DefaultBranchName:default_branch_name` - Define the default branch name.
+- `/Editor:Nano|VIM|Notepad++|VisualStudioCode|VisualStudioCodeInsiders|SublimeText|Atom|VSCodium|Notepad|Wordpad|Custom editor path` - Default editor used by Git. The selected editor needs to be available on the machine (unless it is part of git for windows) for this to work.
+
+## Experimental parameters
+
+Warning: the following parameters are experimental in the git installer and could stop working at any point.
+
+- `/PseudoConsoleSupport` - Enable experimental support for pseudo consoles. Allows running native console programs like Node or Python in a Git Bash window without using winpty, but it still has known bugs.
+- `/FSMonitor` - Enable experimental built-in file system monitor. Automatically run a built-in file system watcher, to speed up common operations such as `git status`, `git add`, `git commit`, etc in worktrees containing many files.
+
+Example: `choco install git.install --params "/GitAndUnixToolsOnPath /NoGitLfs /SChannel /NoAutoCrlf"`

automatic/git.install/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2022-06-13
+
+- Moved Package Arguments into its own markdown file to trim down the description link.
+
 ## 2020-04-02
 
 - Added stopping of the gpg agent to prevent failures during upgrade

automatic/git.install/README.md

@@ -1,40 +1,19 @@
 # <img src="https://cdn.jsdelivr.net/gh/chocolatey-community/chocolatey-packages@10a8d98b2f320b565fa5349a4352e79666db71ff/icons/git.svg" width="48" height="48"/> [git.install](https://chocolatey.org/packages/git.install)
 
-
 Git for Windows focuses on offering a lightweight, native set of tools that bring the full feature set of the Git SCM to Windows while providing appropriate user interfaces for experienced Git users and novices alike.
 
 ## Features
 
-* **Git BASH**: Git for Windows provides a BASH emulation used to run Git from the command line. *NIX users should feel right at home, as the BASH emulation behaves just like the "git" command in LINUX and UNIX environments.
-* **Git GUI**: As Windows users commonly expect graphical user interfaces, Git for Windows also provides the Git GUI, a powerful alternative to Git BASH, offering a graphical version of just about every Git command line function, as well as comprehensive visual diff tools.
-* **Shell Integration**: Simply right-click on a folder in Windows Explorer to access the BASH or GUI.
+- **Git BASH**: Git for Windows provides a BASH emulation used to run Git from the command line. *NIX users should feel right at home, as the BASH emulation behaves just like the "git" command in LINUX and UNIX environments.
+- **Git GUI**: As Windows users commonly expect graphical user interfaces, Git for Windows also provides the Git GUI, a powerful alternative to Git BASH, offering a graphical version of just about every Git command line function, as well as comprehensive visual diff tools.
+- **Shell Integration**: Simply right-click on a folder in Windows Explorer to access the BASH or GUI.
 
 ## Package parameters
 
-- `/GitOnlyOnPath` - Puts gitinstall\cmd on path. This is also done by default if no package parameters are set.
-- `/GitAndUnixToolsOnPath` - Puts gitinstall\bin on path. This setting will override `/GitOnlyOnPath`.
-- `/NoAutoCrlf` - Ensure _'Checkout as is, commit as is'_. This setting **only affects new installs**, it will not override an existing `.gitconfig`.
-- `/WindowsTerminal` - Makes `vim` use the regular Windows terminal instead of MinTTY terminal.
-- `/NoShellIntegration` - Disables open GUI and open shell integration ( _"Git GUI Here"_ and _"Git Bash Here"_ entries in context menus).
-- `/NoGuiHereIntegration` - Disables open GUI shell integration ( _"Git GUI Here"_ entry in context menus).
-- `/NoShellHereIntegration` - Disables open git bash shell integration ( _"Git Bash Here"_ entry in context menus).
-- `/NoCredentialManager` - Disable _Git Credential Manager_ by adding `$Env:GCM_VALIDATE='false'` user environment variable.
-- `/NoGitLfs` - Disable Git LFS installation.
-- `/SChannel` - Configure Git to use the Windows native SSL/TLS implementation (SChannel) instead of OpenSSL. This aligns Git HTTPS behavior with other Windows applications and system components and increases manageability in enterprise environments.
-- `/NoOpenSSH` - Git will not install its own OpenSSH (and related) binaries but use them as found on the PATH.
-- `/WindowsTerminalProfile` - Add a Git Bash Profile to Windows Terminal.
-- `/Symlinks` - Enable symbolic links (requires the SeCreateSymbolicLink permission). Existing repositories are unaffected by this setting.
-- `/DefaultBranchName:default_branch_name` - Define the default branch name.
-- `/Editor:Nano|VIM|Notepad++|VisualStudioCode|VisualStudioCodeInsiders|SublimeText|Atom|VSCodium|Notepad|Wordpad|Custom editor path` - Default editor used by Git. The selected editor needs to be available on the machine (unless it is part of git for windows) for this to work.
-
-### Experimental parameters
-
-Warning: the following parameters are experimental in the git installer and could stop working at any point.
-
-- `/PseudoConsoleSupport` - Enable experimental support for pseudo consoles. Allows running native console programs like Node or Python in a Git Bash window without using winpty, but it still has known bugs.
-- `/FSMonitor` - Enable experimental built-in file system monitor. Automatically run a built-in file system watcher, to speed up common operations such as `git status`, `git add`, `git commit`, etc in worktrees containing many files.
-
-Example: `choco install git.install --params "/GitAndUnixToolsOnPath /NoGitLfs /SChannel /NoAutoCrlf"`
+See the [Git Package Parameters documentation page](https://github.com/chocolatey-community/chocolatey-packages/blob/master/automatic/git.install/ARGUMENTS.md).
+
+Example for passing in package parameters:
+`choco install git.install --params "/GitAndUnixToolsOnPath /WindowsTerminal /NoAutoCrlf`
 
 ## Notes
 

automatic/git/README.md

@@ -1,40 +1,19 @@
-# <img src="https://cdn.jsdelivr.net/gh/chocolatey-community/chocolatey-packages@10a8d98b2f320b565fa5349a4352e79666db71ff/icons/git.svg" width="48" height="48"/> [git.install](https://chocolatey.org/packages/git.install)
-
+# <img src="https://cdn.jsdelivr.net/gh/chocolatey-community/chocolatey-packages@10a8d98b2f320b565fa5349a4352e79666db71ff/icons/git.svg" width="48" height="48"/> [git](https://chocolatey.org/packages/git)
 
 Git for Windows focuses on offering a lightweight, native set of tools that bring the full feature set of the Git SCM to Windows while providing appropriate user interfaces for experienced Git users and novices alike.
 
 ## Features
 
-* **Git BASH**: Git for Windows provides a BASH emulation used to run Git from the command line. *NIX users should feel right at home, as the BASH emulation behaves just like the "git" command in LINUX and UNIX environments.
-* **Git GUI**: As Windows users commonly expect graphical user interfaces, Git for Windows also provides the Git GUI, a powerful alternative to Git BASH, offering a graphical version of just about every Git command line function, as well as comprehensive visual diff tools.
-* **Shell Integration**: Simply right-click on a folder in Windows Explorer to access the BASH or GUI.
+- **Git BASH**: Git for Windows provides a BASH emulation used to run Git from the command line. *NIX users should feel right at home, as the BASH emulation behaves just like the "git" command in LINUX and UNIX environments.
+- **Git GUI**: As Windows users commonly expect graphical user interfaces, Git for Windows also provides the Git GUI, a powerful alternative to Git BASH, offering a graphical version of just about every Git command line function, as well as comprehensive visual diff tools.
+- **Shell Integration**: Simply right-click on a folder in Windows Explorer to access the BASH or GUI.
 
 ## Package parameters
 
-- `/GitOnlyOnPath` - Puts gitinstall\cmd on path. This is also done by default if no package parameters are set.
-- `/GitAndUnixToolsOnPath` - Puts gitinstall\bin on path. This setting will override `/GitOnlyOnPath`.
-- `/NoAutoCrlf` - Ensure _'Checkout as is, commit as is'_. This setting **only affects new installs**, it will not override an existing `.gitconfig`.
-- `/WindowsTerminal` - Makes `vim` use the regular Windows terminal instead of MinTTY terminal.
-- `/NoShellIntegration` - Disables open GUI and open shell integration ( _"Git GUI Here"_ and _"Git Bash Here"_ entries in context menus).
-- `/NoGuiHereIntegration` - Disables open GUI shell integration ( _"Git GUI Here"_ entry in context menus).
-- `/NoShellHereIntegration` - Disables open git bash shell integration ( _"Git Bash Here"_ entry in context menus).
-- `/NoCredentialManager` - Disable _Git Credential Manager_ by adding `$Env:GCM_VALIDATE='false'` user environment variable.
-- `/NoGitLfs` - Disable Git LFS installation.
-- `/SChannel` - Configure Git to use the Windows native SSL/TLS implementation (SChannel) instead of OpenSSL. This aligns Git HTTPS behavior with other Windows applications and system components and increases manageability in enterprise environments.
-- `/NoOpenSSH` - Git will not install its own OpenSSH (and related) binaries but use them as found on the PATH.
-- `/WindowsTerminalProfile` - Add a Git Bash Profile to Windows Terminal.
-- `/Symlinks` - Enable symbolic links (requires the SeCreateSymbolicLink permission). Existing repositories are unaffected by this setting.
-- `/DefaultBranchName:default_branch_name` - Define the default branch name.
-- `/Editor:Nano|VIM|Notepad++|VisualStudioCode|VisualStudioCodeInsiders|SublimeText|Atom|VSCodium|Notepad|Wordpad|Custom editor path` - Default editor used by Git. The selected editor needs to be available on the machine (unless it is part of git for windows) for this to work.
-
-### Experimental parameters
-
-Warning: the following parameters are experimental in the git installer and could stop working at any point.
-
-- `/PseudoConsoleSupport` - Enable experimental support for pseudo consoles. Allows running native console programs like Node or Python in a Git Bash window without using winpty, but it still has known bugs.
-- `/FSMonitor` - Enable experimental built-in file system monitor. Automatically run a built-in file system watcher, to speed up common operations such as `git status`, `git add`, `git commit`, etc in worktrees containing many files.
-
-Example: `choco install git.install --params "/GitAndUnixToolsOnPath /NoGitLfs /SChannel /NoAutoCrlf"`
+See the [Git Package Parameters documentation page](https://github.com/chocolatey-community/chocolatey-packages/blob/master/automatic/git.install/ARGUMENTS.md).
+
+Example for passing in package parameters:
+`choco install git --params "/GitAndUnixToolsOnPath /WindowsTerminal /NoAutoCrlf`
 
 ## Notes