git/Documentation/git-update-server-info.txt
Stephan Beyer 3240240ff4 Docs: Use "-l::\n--long\n" format in OPTIONS sections
The OPTIONS section of a documentation file contains a list
of the options a git command accepts.

Currently there are several variants to describe the case that
different options (almost) do the same in the OPTIONS section.

Some are:

 -f, --foo::
 -f|--foo::
 -f | --foo::

But AsciiDoc has the special form:

 -f::
 --foo::

This patch applies this form to the documentation of the whole git suite,
and removes useless em-dash prevention, so \--foo becomes --foo.

Signed-off-by: Stephan Beyer <s-beyer@gmx.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-08 13:46:38 -07:00

59 lines
1 KiB
Plaintext

git-update-server-info(1)
=========================
NAME
----
git-update-server-info - Update auxiliary info file to help dumb servers
SYNOPSIS
--------
'git-update-server-info' [--force]
DESCRIPTION
-----------
A dumb server that does not do on-the-fly pack generations must
have some auxiliary information files in $GIT_DIR/info and
$GIT_OBJECT_DIRECTORY/info directories to help clients discover
what references and packs the server has. This command
generates such auxiliary files.
OPTIONS
-------
-f::
--force::
Update the info files from scratch.
OUTPUT
------
Currently the command updates the following files. Please see
linkgit:gitrepository-layout[5][repository-layout] for description of
what they are for:
* objects/info/packs
* info/refs
BUGS
----
When you remove an existing ref, the command fails to update
info/refs file unless `--force` flag is given.
Author
------
Written by Junio C Hamano <junkio@cox.net>
Documentation
--------------
Documentation by Junio C Hamano.
GIT
---
Part of the linkgit:git[1] suite