l3build icon indicating copy to clipboard operation
l3build copied to clipboard

mark custom targets in help

Open jlaurens opened this issue 4 years ago • 3 comments

Section 5.6 of the dtx suggests how to add new targets. Custom targets should be marked (for example with a "(*)" in l3build --help output)

jlaurens avatar Jan 29 '21 09:01 jlaurens

I guess the issue then is what counts: depending on the use case, standard targets can be removed, so there is not a strictly fixed list.

josephwright avatar Jan 29 '21 09:01 josephwright

Is it in any way relevant for the user to know that something is a custom target? I can't see why that it is helpful in a practical way.

FrankMittelbach avatar Jan 29 '21 10:01 FrankMittelbach

If you have a problem with a builtin target, you ask the l3build team If you have a problem with your custom target, then it is yours and you should ask yourself.

So far there is not a desperate need for a custom marker.

But when the user is not the one who wrote the initial build.lua, or when he forgot what is inside the build.lua because it was written a long time ago, or when the build.lua was just adapted from existing material, then knowing that a target is a custom one really helps.

Moreover, the help states that more help is available in l3build.dtx. When a target is marked custom, you now that there is no more help available there.

jlaurens avatar Jan 30 '21 10:01 jlaurens