diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-10-12 14:05:20 +0000 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-10-12 14:05:20 +0000 |
| commit | 9b04e69a1fcb4a39d2873e5e6a396f7f16884098 (patch) | |
| tree | 48ad40786daceda905de7f9c886131c744311cd2 | |
| parent | 30e6c1bc136aa50e548fb4f48b2f5882e0267ad0 (diff) | |
| parent | 45418734311561bb72aa5ab7a89d81bbd5705f7a (diff) | |
| download | gitlab-ce-9b04e69a1fcb4a39d2873e5e6a396f7f16884098.tar.gz | |
Merge branch 'git-attributes-documentation' into 'master'
Added documentation chapter for Git attributes
See https://gitlab.com/gitlab-org/gitlab_git/issues/28 for more information.
See merge request !6826
| -rw-r--r-- | CHANGELOG | 1 | ||||
| -rw-r--r-- | doc/README.md | 1 | ||||
| -rw-r--r-- | doc/user/project/git_attributes.md | 22 |
3 files changed, 24 insertions, 0 deletions
diff --git a/CHANGELOG b/CHANGELOG index e478e8c3365..894f4bc9af0 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -14,6 +14,7 @@ v 8.13.0 (unreleased) - Clarify documentation for Runners API (Gennady Trafimenkov) - Change user & group landing page routing from /u/:username to /:username - Prevent running GfmAutocomplete setup for each diff note !6569 + - Added documentation for .gitattributes files - AbstractReferenceFilter caches project_refs on RequestStore when active - Replaced the check sign to arrow in the show build view. !6501 - Add a /wip slash command to toggle the Work In Progress status of a merge request. !6259 (tbalthazar) diff --git a/doc/README.md b/doc/README.md index 42ee44f83dc..7e3d9b00900 100644 --- a/doc/README.md +++ b/doc/README.md @@ -20,6 +20,7 @@ - [Webhooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project. - [Workflow](workflow/README.md) Using GitLab functionality and importing projects from GitHub and SVN. - [University](university/README.md) Learn Git and GitLab through videos and courses. +- [Git Attributes](user/project/git_attributes.md) Managing Git attributes using a `.gitattributes` file. ## Administrator documentation diff --git a/doc/user/project/git_attributes.md b/doc/user/project/git_attributes.md new file mode 100644 index 00000000000..21ef94e61f7 --- /dev/null +++ b/doc/user/project/git_attributes.md @@ -0,0 +1,22 @@ +# Git Attributes + +GitLab supports defining custom [Git attributes][gitattributes] such as what +files to treat as binary, and what language to use for syntax highlighting +diffs. + +To define these attributes, create a file called `.gitattributes` in the root +directory of your repository and push it to the default branch of your project. + +## Encoding Requirements + +The `.gitattributes` file _must_ be encoded in UTF-8 and _must not_ contain a +Byte Order Mark. If a different encoding is used, the file's contents will be +ignored. + +## Syntax Highlighting + +The `.gitattributes` file can be used to define which language to use when +syntax highlighting files and diffs. See ["Syntax +Highlighting"](highlighting.md) for more information. + +[gitattributes]: https://git-scm.com/docs/gitattributes |