Package: devscripts Version: 2.25.15 Severity: minor X-Debbugs-Cc: [email protected];[email protected]
HiReading through the man page for the `Version: 5` watch file, I found a mismatch between the documentation for `Git-Modules` and some of the examples. The mismatch might be from the previous version (I did not check).
The description for `Git-Modules` is:
```
Git-Modules: <modules>
Clone one or more submodules after cloning the main git repository.
By default, uscan will clone all submodules linked to the git
repository.
To clone selected submodules, use a semicolon-separated list. For
example: Git-Modules=m4;doc/common.
```
Note here:
A) By default *all* git submodules are cloned
B) A semi-colon separated list of paths can be provided to disable that
and choose which submodules to clone.
Then further down, under the heading "direct access to the git
repository (with submodules)", we see the example like:
``` Use Git-Modules to clone all submodules: Version: 5 Source: https://github.com/namespace/project Version-Regex: [refs/tags/v@ANY_VERSION@|HEAD] Git-Mode: shallow Git-Modules: yes Mode: git ```Here we have an example describing how to fetch all git submodules, but according to the docs of `Git-Modules` that is the default behavior. Even it was not, then `Git-Modules` is not a boolean option according to the docs so `yes` seems like a weird example value.
I do not know the code well enough to say what is correct. But I can see the documentation contradicts itself on what `Git-Modules` do, what values it accepts and what the default behavior for it is.
As mentioned, this might be a bug from the v4 format that was just carried over.
Best regards, Niels
OpenPGP_signature.asc
Description: OpenPGP digital signature
