Re: [PATCH 25/25] list-files: documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, Apr 6, 2015 at 9:52 AM, Nguyễn Thái Ngọc Duy <pclouds@xxxxxxxxx> wrote:
> Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@xxxxxxxxx>
> ---
> diff --git a/Documentation/git-list-files.txt b/Documentation/git-list-files.txt
> new file mode 100644
> index 0000000..9b9edce
> --- /dev/null
> +++ b/Documentation/git-list-files.txt
> @@ -0,0 +1,115 @@
> +git-list-files(1)
> +===============
> +
> +NAME
> +----
> +git-list-files - List files
> +
> +SYNOPSIS
> +--------
> +[verse]
> +'git list-files [options] [<pathspec>...]
> +
> +DESCRIPTION
> +-----------
> +List files (by default in current working directory) that are in the
> +index. Depending on the chosen options, maybe only modified files in
> +working tree are shown, or untracked files... The builtin alias "ls"
> +is set to "list-files".
> +
> +OPTIONS
> +-------
> +-c::
> +--cached::
> +       Show cached files (default)

Here and elsewhere: s/$/./

> +-d::
> +--deleted::
> +       Show deleted files in index, compared to HEAD
> +
> +-a::
> +--added::
> +       Show added files in index, compared to HEAD
> +
> +-m::
> +--modified::
> +       Show modified files in index, compared to HEAD. This implies
> +       --deleted and --added

s/--deleted/`--deleted`/
s/--added/`--added`/

> +-D::
> +--wt-deleted::
> +       Show deleted files in working directory
> +
> +-A::
> +--wt-added::
> +       Show added files in working directory
> +
> +-M::
> +--wt-modified::
> +       Show modified files in working directory. This implies
> +       --wt-deleted and --wt-added

s/--wt-deleted/`--wt-deleted`/
s/--wt-added/`--wt-added`/

> +-o::
> +--others::
> +       Show untracked files (and only unignored ones unless -i is

s/-i/`-i`/ ...or... s/-i/`--ignored`/

> +       specified)
> +
> +-i::
> +--ignored::
> +       Show only ignored files. When showing files in the index,
> +       print only those matched by an exclude pattern. When showing
> +       "other" files, show only those matched by an exclude pattern.
> +
> +-u::
> +--unmerged::
> +       Show unmerged files
> +
> +-F::
> +--classify::
> +       Append indicator (one of `*/=>@|&`, which is executable,
> +       directory, socket, Solaris door, symlink, fifo, or submodule
> +       respectively) to entries.
> +
> +--color[=<when>]::
> +--no-color::
> +       Color file names. The value must be `always`, `never`, or
> +       `auto`. `--no-color` is equivalent to
> +       `--color=never`. `--color` is equivalent to
> +       `--color=auto`. See configuration variable `color.list-files`

Is 'color.list-files' documented anywhere?

> +       for the default settings.
> +
> +--column[=<options>]::
> +--no-column::
> +-1::
> +       Display files in columns. See configuration variable column.ui

s/column.ui/`column.ui`/

> +       for option syntax. `--column` and `--no-column` without options
> +       are equivalent to 'always' and 'never' respectively.
> +       `-1` is a shortcut for --no-column.

s/--no-column/`--no-column`/

> +--max-depth=<depth>::
> +--recursive::
> +-R::
> +       For each <pathspec> given on command line, descend at most <depth>
> +       levels of directories. A negative value means no limit.
> +       This option is ignored if <pathspec> contains active wildcards.
> +       In other words if "a*" matches a directory named "a*",
> +       "*" is matched literally so --max-depth is still effective.

s/--max-depth/`--max-depth`/

> +       `-R` or `--recursive` is equivalent of `--max-depth=-1`
> +       (infinite recursion).  The default is `--max-depth=0`.
> +
> +--tag::
> +--no-tag::
> +       Usually when tags are displayed by the left of the file name if
> +       there are more than one file selection. Use either of these options
> +       to force always or never display tags.

This is somewhat difficult to parse. Perhaps it could be rephrased
something like this:

    If the disposition of listed files differs from one another, then
    tags ("D" deleted, "M" modified, etc.) are displayed in front of
    the file names; otherwise tags are suppressed. These options
    override the the behavior and explicitly show or suppress tags,
    respectively.

> +
> +<pathspec>::
> +       Files to show. :(glob) magic is enabled by default.
> +
> +SEE ALSO
> +--------
> +linkgit:git-ls-files[1]
> +
> +GIT
> +---
> +Part of the linkgit:git[1] suite
> --
> 2.3.0.rc1.137.g477eb31
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]