Re: [PATCH v7 3/4] cat-file: add documentation for '--literally' option.

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Apr 7, 2015, 20:49 UTC
Message-ID: <CAPig+cRF7-qTby_s=vQPCTN7JYS9=8q3WO3zkbkGUP4Ax=o=wg@mail.gmail.com>
In-Reply-To: <1428126264-19179-1-git-send-email-karthik.188@gmail.com>

On Sat, Apr 4, 2015 at 1:44 AM, Karthik Nayak <karthik.188@gmail.com> wrote:

Show 22 quoted lines

> Signed-off-by: Karthik Nayak <karthik.188@gmail.com>
> ---
> diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
> index f6a16f4..8bac7bd 100644
> --- a/Documentation/git-cat-file.txt
> +++ b/Documentation/git-cat-file.txt
> @@ -9,7 +9,7 @@ git-cat-file - Provide content or type and size information for repository objec
>  SYNOPSIS
>  --------
>  [verse]
> -'git cat-file' (-t | -s | -e | -p | <type> | --textconv ) <object>
> +'git cat-file' (-t [--literally]| -s [--literally]| -e | -p | <type> | --textconv ) <object>
>  'git cat-file' (--batch | --batch-check) < <list-of-objects>
>
>  DESCRIPTION
> @@ -69,6 +69,10 @@ OPTIONS
>         not be combined with any other options or arguments.  See the
>         section `BATCH OUTPUT` below for details.
>
> +--literally::
> +       Print information of broken/corrupt objects of unknown type without
> +       throwing an error. To be used combined with '-s' or '-t' option.

The way this is worded, it sounds as if the --literally option itself is printing some sort of additional information beyond what -s or -t outputs. In fact, it merely allows -s and -t to work with broken/corrupt objects. Perhaps rephrase something like this?

    Allow -s or -t to query broken or corrupt objects of
    unknown type.

Show 6 quoted lines

>  OUTPUT
>  ------
>  If '-t' is specified, one of the <type>.
> --
> 2.4.0.rc1.249.g9f2ee54
>