summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-01-21 22:12:17 +0000
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-01-21 22:12:17 +0000
commit38c830ef0f91ab29334d9bfc024180ec4f9f3dab (patch)
treea260a845d58ef433980d6f43a04b273eb49f684c
parentc176fb40a52d32edc54843a5b54884cbab1e67e1 (diff)
parente08e90edbbd28533f215f0dcf274baefb9fc87fd (diff)
downloadgitlab-ce-38c830ef0f91ab29334d9bfc024180ec4f9f3dab.tar.gz
Merge branch 'housekeeping-doc' into 'master'
Add housekeeping feature documentation Add documentation about the new housekeeping feature in the project settings page. See merge request !2371
-rw-r--r--doc/README.md1
-rw-r--r--doc/administration/housekeeping.md22
-rw-r--r--doc/administration/img/housekeeping_settings.pngbin0 -> 23856 bytes
3 files changed, 23 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
index 8e259c364aa..5089e1e70f6 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -69,6 +69,7 @@
- [Reply by email](incoming_email/README.md) Allow users to comment on issues and merge requests by replying to notification emails.
- [Migrate GitLab CI to CE/EE](migrate_ci_to_ce/README.md) Follow this guide to migrate your existing GitLab CI data to GitLab CE/EE.
- [Git LFS configuration](workflow/lfs/lfs_administration.md)
+- [Housekeeping](administration/housekeeping.md) Keep your Git repository tidy and fast.
- [GitLab Performance Monitoring](monitoring/performance/introduction.md) Configure GitLab and InfluxDB for measuring performance metrics
## Contributor documentation
diff --git a/doc/administration/housekeeping.md b/doc/administration/housekeeping.md
new file mode 100644
index 00000000000..c27cf1812dc
--- /dev/null
+++ b/doc/administration/housekeeping.md
@@ -0,0 +1,22 @@
+# Housekeeping
+
+_**Note:** This feature was [introduced][ce-2371] in GitLab 8.4_
+
+---
+
+The housekeeping function runs [`git gc`][man] on the current project Git
+repository.
+
+`git gc` runs a number of housekeeping tasks, such as compressing file
+revisions (to reduce disk space and increase performance) and removing
+unreachable objects which may have been created from prior invocations of
+`git add`.
+
+You can find this option under your **[Project] > Settings**.
+
+---
+
+![Housekeeping settings](img/housekeeping_settings.png)
+
+[ce-2371]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2371 "Housekeeping merge request"
+[man]: https://www.kernel.org/pub/software/scm/git/docs/git-gc.html "git gc man page"
diff --git a/doc/administration/img/housekeeping_settings.png b/doc/administration/img/housekeeping_settings.png
new file mode 100644
index 00000000000..f7c5bc44367
--- /dev/null
+++ b/doc/administration/img/housekeeping_settings.png
Binary files differ