On Wed, Dec 11, 2024 at 08:17:15PM +0100, Kirill A. Korinsky wrote:
> On Wed, 11 Dec 2024 19:02:48 +0100,
> Sebastien Marie <sema...@kapouay.eu.org> wrote:
> >
> > Regarding the documentation, I think it should mention that it do not
> > affect the build in any way : cargo is looking at MODCARGO_CARGOTOML
> > path only. Otherwise it could be confusing for the packager to have
> > both.
> >
> > Maybe something like "used only by modcargo-gen-crates target" ?
> >
>
> What do you think about this wording?
>
> Index: share/man/man5/cargo-module.5
> ===================================================================
> RCS file: /home/cvs/src/share/man/man5/cargo-module.5,v
> diff -u -p -r1.9 cargo-module.5
> --- share/man/man5/cargo-module.5 6 Jan 2024 08:03:31 -0000 1.9
> +++ share/man/man5/cargo-module.5 11 Dec 2024 19:15:37 -0000
> @@ -93,6 +93,10 @@ This module defines:
> Path to cargo manifest.
> Defaults to
> .Pa ${WRKSRC}/Cargo.toml .
> +.It Ev MODCARGO_CARGOLOCK
> +Path to Cargo.lock which is used only by modcargo-gen-crates target.
I think this should use some markup for consistency with the rest of the
file, for example:
Path to Cargo.lock, which is used only by the
.Cm modcargo-gen-crates
target.
Not sure if it should be '.Pa Cargo.lock' as well, or perhaps spell it
out as 'cargo lock file' like it is done in the Cargo.toml entry.
> +Defaults to
> +.Pa ${MODCARGO_CARGOTOML:toml=lock} .
> .It Ev MODCARGO_CRATES
> Crates that will be downloaded by the module.
> .It Ev MODCARGO_CRATES_UPDATE
>
> --
> wbr, Kirill
>
