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

Bug#932696: Please document Haskell team style Vcs-Git sytax



> +    In the case of Git, the value must have the following syntax::
> +
> +        <url> [ " -b " <branch> ] [ "[" <path> "]" ]

That should be " [" (including a leading space).

> +
> +    where the portions enclosed in brackets are optional and the portions
> +    enclosed in double quotes are literal strings.  ``<url>`` indicates
> +    the repository.  If the ``<branch>`` stanza is present, it names a
> +    branch in the indicated repository.  If no branch is specified, the
> +    packaging should be on the default branch.  If the ``<path>`` stanza
> +    is present, it must be a relative path naming a subdirectory in that
> +    repository and branch.  If no path is specified, the ``debian``
> +    directory containing the packaging is expected to be at the top level
> +    of the indicated repository and branch.

I suggest something like "If <path> is not specified, it defaults to `.`
(or `debian`; see below)".

> +
> +    For example::
> +
> +        Vcs-Git: https://example.org/repo -b debian [p/package]
> +
> +    indicates a subdirectory named ``p/package`` in the ``debian`` branch
> +    of the repository at ``https://example.org/repo``.

I don't understand what <path> does from just reading this.  When
`p/package` is given, which one of `p/package/debian/control` and
`p/package/control` is supposed to be used?

Ansgar


Reply to: