survey: progress on man page

Signed-off-by: Jeff Hostetler <[email protected]>

Documentation/git-survey.txt

@@ -3,9 +3,70 @@ git-survey(1)
 
 NAME
 ----
-(EXPERIMENTAL) git-exp-survey - Measure various repository dimensions of scale
+git-survey - EXPERIMENTAL: Measure various repository dimensions of scale
 
 SYNOPSIS
 --------
+[verse]
+(EXPERIMENTAL!) 'git survey <options>
 
-TO be continued...
+DESCRIPTION
+-----------
+
+Survey the repository and measure various dimensions of scale.
+
+As repositories grow to "monorepo" size, certain data shapes can cause
+performance problems.  `git-survey` attempts to measure and report on
+known problem areas.
+
+Ref Selection and Reachable Objects
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In this first analysis phase, 'survey' will iterate over the set of
+requested branches, tags, and other refs and treewalk over all of the
+reachable commits, trees, and blobs and generate various statistics.
+
+OPTIONS
+-------
+
+--progress::
+	Show progress.  This is automatically enabled when interactive.
+
+Ref Selection
+~~~~~~~~~~~~~
+
+The following options control the set of refs that 'survey' will examine.
+By default, 'survey' will look at tags, local branches, and remote refs.
+If any of the following options are given, the default set is cleared and
+only refs for the given options are added.
+
+--all-refs::
+	Use all refs.  This includes local branches, tags, remote refs,
+	notes, stashes, and certain refs in custom namespaces.  This option
+	overrides all of the following.
+
+--branches::
+	Add local branches ('refs/heads/') to the set.
+
+--tags::
+	Add tags ('refs/tags/') to the set.
+
+--remotes::
+	Add remote branches ('refs/remote/') to the set.
+
+--detached::
+	Add HEAD to the set.
+
+--other::
+	Add notes ('refs/notes/') and stashes ('refs/stash/') to the set.
+
+--prefetch::
+	Add custom namespace ('refs/prefetch/') to the set.  This namespace
+	is used by background/nightly 'git maintenance' to prefetch commits.
+
+OUTPUT
+------
+
+GIT
+---
+Part of the linkgit:git[1] suite

builtin/survey.c

@@ -18,7 +18,7 @@
 #include "tree-walk.h"
 
 static const char * const survey_usage[] = {
-	N_("git survey [<options>])"),
+	N_("(EXPERIMENTAL!) git survey [<options>])"),
 	NULL,
 };