[m-rev.] for post-commit review: start documenting PROPOSED search options

[Julien Fischer]

On Fri, 20 Dec 2024 at 01:41, Zoltan Somogyi <zoltan.somogyi at runbox.com>
wrote:

>
>
> On Thu, 19 Dec 2024 23:47:27 +1100, Julien Fischer <jfischer at opturion.com>
> wrote:
> > On Tue, 17 Dec 2024 at 14:33, Zoltan Somogyi <zoltan.somogyi at runbox.com>
> wrote:
>
> > > + at c @c
> > > + at c @c XXX Once there is agreement on the structure of this entry, it
> will be
> > > + at c @c duplicated, mutatis mutandis, for the other three groups of
> PROPOSED
> > > + at c @c search dir options.
> > > + at c @sp 1
> > > + at c @item --normal-dirs-same @var{workspacedir}
> > > + at c @itemx --normal-dirs-indep @var{workspacedir}
> >
> > I think these two should include "workspace" in their names.
> > Yes, it's longer but it is also clearer.
>
> Ok, I will provide at least these spellings of that last option:
>
> --interface-dir-indep-ws
> --interface-dir-independent-workspace
>
> which abbreviate both components or spell out both components in full.
>
> Should I also add the mixed abbrev/full versions below?
>
> --interface-dir-indep-workspace
> --interface-dir-independent-ws
>
> My vote would be "no".
>

No.

Should the order of the last two components be indep/ws or ws/indep?
> I prefer the former, though only slightly.
>

I don't have a preference.

> > + at c @cindex Directories
> > > + at c @cindex Search path
> > > + at c Append either the named workspace directory,
> > > + at c or the named library install directory,
> > > + at c to one of three separate lists of directories to be searched
> > > + at c for @samp{.int*} and @samp{.module_dep} files.
> > > + at c Any workspace directory
> > > + at c named in a @var{--normal-dirs-same} option
>
> Should this fully-spelt-out name of the option be followed here by
> "(synonyms: <list them here>)"?
>

The synonyms should be listed above anyway, so I don't think you need
to repeat them inline.

Julien.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mercurylang.org/archives/reviews/attachments/20241220/73c8f783/attachment.html>